diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d920444c..0c3e509e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] + +## [0.5.6] - 2018-10-07 - Added a package command to package either fat jar or a JVMCI fat jar. - Fix issue preventing GraalJS running on OpenJ9 - Allow specifying absolute path as start module @@ -18,6 +20,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Decoupled Codec from the engine (avoids calls on the wrong context) - Several clean ups +## [0.5.5] - Demo release +- Small fixes in order to get demos running + ## [0.5.4] - 2018-09-17 - Bump `pg-reactive-client` to 0.10.3 - Fix `parsePaths` to properly convert slashes on windows. diff --git a/codegen/pom.xml b/codegen/pom.xml new file mode 100644 index 000000000..8a478d397 --- /dev/null +++ b/codegen/pom.xml @@ -0,0 +1,47 @@ + + + + + io.reactiverse + es4x-parent + 0.6.0 + .. + + + 4.0.0 + + es4x-codegen + 0.6.0 + + + + + + + io.vertx + vertx-core + ${vertx.version} + + + io.vertx + vertx-codegen + ${vertx.version} + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + com.amashchenko.maven.plugin + gitflow-maven-plugin + + + + + diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/ES4XGeneratorLoader.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/ES4XGeneratorLoader.java new file mode 100644 index 000000000..4d6f935cc --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/ES4XGeneratorLoader.java @@ -0,0 +1,45 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen; + +import io.reactiverse.es4x.codegen.generator.*; +import io.vertx.codegen.Generator; +import io.vertx.codegen.GeneratorLoader; + +import javax.annotation.processing.ProcessingEnvironment; +import java.util.LinkedList; +import java.util.List; +import java.util.stream.Stream; + +public class ES4XGeneratorLoader implements GeneratorLoader { + @Override + public Stream> loadGenerators(ProcessingEnvironment processingEnv) { + + final List> generators = new LinkedList<>(); + + generators.add(new IndexJS()); + generators.add(new IndexDTS()); + generators.add(new OptionsJS()); + generators.add(new OptionsDTS()); + generators.add(new EnumJS()); + generators.add(new EnumDTS()); + generators.add(new ReadmeMD()); + generators.add(new PackageJSON()); + + return generators.stream(); + + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/EnumDTS.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/EnumDTS.java new file mode 100644 index 000000000..36d478b20 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/EnumDTS.java @@ -0,0 +1,68 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.EnumModel; +import io.vertx.codegen.EnumValueInfo; +import io.vertx.codegen.Generator; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Map; + +public class EnumDTS extends Generator { + + public EnumDTS() { + incremental = true; + + kinds = new HashSet<>(); + kinds.add("enum"); + + name = "es4x-generator (enum.d.ts)"; + } + + @Override + public String filename(EnumModel model) { + return "npm/enums.d.ts"; + } + + @Override + public String render(EnumModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + if (index == 0) { + Util.generateLicense(writer); + } else { + writer.print("\n"); + } + + writer.printf("export enum %s {\n", model.getType().getRaw().getSimpleName()); + for (int i = 0; i < model.getValues().size(); i++) { + EnumValueInfo value = model.getValues().get(i); + writer.printf(" %s", value.getIdentifier()); + if (i != model.getValues().size() - 1) { + writer.print(","); + } + writer.print("\n"); + } + writer.print("}\n"); + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/EnumJS.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/EnumJS.java new file mode 100644 index 000000000..9e2fa9842 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/EnumJS.java @@ -0,0 +1,70 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.Generator; +import io.vertx.codegen.EnumModel; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Map; + +import static io.reactiverse.es4x.codegen.generator.Util.*; + +public class EnumJS extends Generator { + + public EnumJS() { + incremental = true; + + kinds = new HashSet<>(); + kinds.add("enum"); + + name = "es4x-generator (enum.js)"; + } + + @Override + public String filename(EnumModel model) { + return "npm/enums.js"; + } + + @Override + public String render(EnumModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + if (index == 0) { + Util.generateLicense(writer); + writer.printf("/// \n", getNPMScope(model.getType().getRaw().getModule())); + writer.print("module.exports = {\n"); + } + + writer.printf(" %s: Java.type('%s')", model.getType().getRaw().getSimpleName(), model.getType().getName()); + + if (index != size - 1) { + writer.print(','); + } + + writer.print('\n'); + + if (index == size - 1) { + writer.print("};\n"); + } + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/IndexDTS.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/IndexDTS.java new file mode 100644 index 000000000..d28ab65fd --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/IndexDTS.java @@ -0,0 +1,186 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.*; +import io.vertx.codegen.type.ApiTypeInfo; +import io.vertx.codegen.type.ClassTypeInfo; +import io.vertx.codegen.type.EnumTypeInfo; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.*; + +import static io.reactiverse.es4x.codegen.generator.Util.*; + +public class IndexDTS extends Generator { + + public IndexDTS() { + incremental = true; + + kinds = new HashSet<>(); + kinds.add("class"); + + name = "es4x-generator (index.d.ts)"; + } + + @Override + public String filename(ClassModel model) { + return "npm/index.d.ts"; + } + + @Override + public String render(ClassModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + ClassTypeInfo type = model.getType(); + + if (index == 0) { + Util.generateLicense(writer); + + if (type.getModuleName().equals("vertx")) { + writer.print("export interface Handler {\n"); + writer.print(" handle(arg0: T) : void;\n"); + writer.print("}\n\n"); + writer.print("export interface AsyncResult {\n"); + writer.print(" succeeded() : boolean;\n"); + writer.print(" failed() : boolean;\n"); + writer.print(" cause() : Error | null;\n"); + writer.print(" result() : T | null;\n"); + writer.print("}\n\n"); + } else { + writer.print("import { Handler, AsyncResult } from '@vertx/core';\n\n"); + } + } else { + writer.print("\n"); + } + + boolean imports = false; + + for (ApiTypeInfo referencedType : model.getReferencedTypes()) { + if (!isImported(referencedType, session)) { + if (!referencedType.getRaw().getModuleName().equals(type.getModuleName())) { + writer.printf("import { %s } from '%s';\n", referencedType.getSimpleName(), getNPMScope(referencedType.getRaw().getModule())); + imports = true; + } + } + } + for (ClassTypeInfo dataObjectType : model.getReferencedDataObjectTypes()) { + if (!isImported(dataObjectType, session)) { + if (dataObjectType.getRaw().getModuleName().equals(type.getModuleName())) { + writer.printf("import { %s } from './options';\n", dataObjectType.getSimpleName()); + imports = true; + } else { + writer.printf("import { %s } from '%s/options';\n", dataObjectType.getSimpleName(), getNPMScope(dataObjectType.getRaw().getModule())); + imports = true; + } + } + } + for (EnumTypeInfo enumType : model.getReferencedEnumTypes()) { + if (!isImported(enumType, session)) { + if (enumType.getRaw().getModuleName().equals(type.getModuleName())) { + writer.printf("import { %s } from './enums';\n", enumType.getSimpleName()); + imports = true; + } else { + writer.printf("import { %s } from '%s/enums';\n", enumType.getSimpleName(), getNPMScope(enumType.getRaw().getModule())); + imports = true; + } + } + } + + if (imports) { + writer.print("\n"); + } + + final Set superTypes = new HashSet<>(); + model.getAbstractSuperTypes().forEach(ti -> superTypes.add(genType(ti))); + + if (model.getHandlerType() != null) { + if (model.isConcrete()) { + superTypes.add("Handler<" + genType(model.getHandlerType()) + ">"); + } + } + + writer.printf("export %s %s%s", model.isConcrete() ? "abstract class" : "interface", type.getSimpleName(), genGeneric(type.getParams())); + + if (model.isConcrete()) { + if (model.getConcreteSuperType() != null) { + writer.printf(" extends %s", genType(model.getConcreteSuperType())); + } + if (!superTypes.isEmpty()) { + writer.printf(" implements %s", String.join(", ", superTypes)); + } + } else { + if (model.getHandlerType() != null) { + writer.printf(" extends Handler<%s>", genType(model.getHandlerType())); + } + if (!superTypes.isEmpty()) { + writer.printf(" extends %s", String.join(", ", superTypes)); + } + } + + writer.print(" {\n"); + + boolean moreConstants = false; + // this looks awkward (and it is) but TS does not allow static constants in interfaces + // so they get listed on the abstract classes. + if (!model.isConcrete()) { + for (ConstantInfo constant : model.getConstants()) { + if (moreConstants) { + writer.print("\n"); + } + + if (constant.getDoc() != null) { + writer.print(" /**\n"); + writer.printf(" *%s\n", constant.getDoc().toString().replace("\n", "\n * ")); + writer.print(" */\n"); + } + writer.printf(" static readonly %s : %s;\n", constant.getName(), genType(constant.getType())); + moreConstants = true; + } + } + + boolean moreMethods = false; + for (MethodInfo method : model.getMethods()) { + if (moreMethods || moreConstants) { + writer.print("\n"); + } + + if (method.getDoc() != null) { + writer.print(" /**\n"); + writer.printf(" *%s\n", method.getDoc().toString().replace("\n", "\n * ")); + writer.print(" */\n"); + } + writer.printf(" %s%s%s(", method.isStaticMethod() ? "static " : "", method.getName(), genGeneric(method.getTypeParams())); + boolean more = false; + for (ParamInfo param : method.getParams()) { + if (more) { + writer.print(", "); + } + writer.printf("%s: %s%s", param.getName(), genType(param.getType()), param.getType().isNullable() ? " | null | undefined" : ""); + more = true; + } + + writer.printf(") : %s%s;\n", genType(method.getReturnType()), method.getReturnType().isNullable() ? " | null" : ""); + moreMethods = true; + } + writer.print("}\n"); + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/IndexJS.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/IndexJS.java new file mode 100644 index 000000000..2a3c87f31 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/IndexJS.java @@ -0,0 +1,74 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.ClassModel; +import io.vertx.codegen.Generator; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Map; + +import static io.reactiverse.es4x.codegen.generator.Util.getNPMScope; + +public class IndexJS extends Generator { + + public IndexJS() { + incremental = true; + + kinds = new HashSet<>(); + kinds.add("class"); + + name = "es4x-generator (index.js)"; + } + + @Override + public String filename(ClassModel model) { + return "npm/index.js"; + } + + @Override + public String render(ClassModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + if (index == 0) { + Util.generateLicense(writer); + + writer.printf("/// \n", getNPMScope(model.getType().getRaw().getModule())); + writer.print("module.exports = {\n"); + if (model.getType().getRaw().getModuleName().equals("vertx")) { + writer.print(" AsyncResult: Java.type('io.vertx.core.AsyncResult'),\n"); + } + } + + writer.printf(" %s: Java.type('%s')", model.getType().getRaw().getSimpleName(), model.getType().getName()); + + if (index != size - 1) { + writer.print(','); + } + + writer.print('\n'); + + if (index == size - 1) { + writer.print("};\n"); + } + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/OptionsDTS.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/OptionsDTS.java new file mode 100644 index 000000000..b6be31054 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/OptionsDTS.java @@ -0,0 +1,160 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.*; +import io.vertx.codegen.type.ClassKind; +import io.vertx.codegen.type.ClassTypeInfo; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.*; + +import static io.reactiverse.es4x.codegen.generator.Util.*; + +public class OptionsDTS extends Generator { + + public OptionsDTS() { + incremental = true; + + kinds = new HashSet<>(); + kinds.add("dataObject"); + + name = "es4x-generator (options.d.ts)"; + } + + @Override + public String filename(DataObjectModel model) { + return "npm/options.d.ts"; + } + + private Collection filterImports(Map properties) { + Set result = new HashSet<>(); + for (PropertyInfo p : properties.values()) { + p.getType().collectImports(result); + } + + return result; + } + @Override + public String render(DataObjectModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + boolean imports = false; + + if (index == 0) { + Util.generateLicense(writer); + } else { + writer.print("\n"); + } + + for (ClassTypeInfo referencedType : filterImports(model.getPropertyMap())) { + if (!isImported(referencedType, session)) { + if (referencedType.getKind() == ClassKind.ENUM) { + if (referencedType.getRaw().getModuleName().equals(model.getType().getRaw().getModuleName())) { + writer.printf("import { %s } from './enums';\n", referencedType.getSimpleName()); + imports = true; + } else { + writer.printf("import { %s } from '%s/enums';\n", referencedType.getSimpleName(), getNPMScope(referencedType.getRaw().getModule())); + imports = true; + } + } + if (referencedType.getKind() == ClassKind.DATA_OBJECT) { + if (!referencedType.getRaw().getModuleName().equals(model.getType().getRaw().getModuleName())) { + writer.printf("import { %s } from '%s/options';\n", referencedType.getSimpleName(), getNPMScope(referencedType.getRaw().getModule())); + imports = true; + } + } + if (referencedType.getKind() == ClassKind.API) { + if (referencedType.getRaw().getModuleName().equals(model.getType().getRaw().getModuleName())) { + writer.printf("import { %s } from './index';\n", referencedType.getSimpleName()); + imports = true; + } else { + writer.printf("import { %s } from '%s';\n", referencedType.getSimpleName(), getNPMScope(referencedType.getRaw().getModule())); + imports = true; + } + } + } + } + + if (imports) { + writer.print("\n"); + } + + writer.printf("export %sclass %s {\n", model.isConcrete() ? "" : "abstract ", model.getType().getRaw().getSimpleName()); + + // TODO: handle extends/implements + + writer.print("\n"); + writer.print(" constructor();\n"); + // copy constructor + writer.printf(" constructor(obj: %s);\n", model.getType().getRaw().getSimpleName()); + + boolean more = false; + + for (Map.Entry entry : model.getPropertyMap().entrySet()) { + + final PropertyInfo property = entry.getValue(); + + if (more) { + writer.print("\n"); + } + + // write getter + if (property.getDoc() != null) { + writer.print(" /**\n"); + writer.printf(" *%s\n", property.getDoc().toString().replace("\n", "\n * ")); + writer.print(" */\n"); + } + // custom vert.x style + String getter = property.getGetterMethod(); + writer.printf(" %s(): %s;\n", getter == null ? entry.getKey() : getter, genType(property.getType())); + + + if (property.isSetter()) { + // write setter + writer.print("\n"); + + if (property.getDoc() != null) { + writer.print(" /**\n"); + writer.printf(" *%s\n", property.getDoc().toString().replace("\n", "\n * ")); + writer.print(" */\n"); + } + writer.printf(" %s(%s: %s): %s;\n", property.getSetterMethod(), entry.getKey(), genType(property.getType()), model.getType().getRaw().getSimpleName()); + } + + if (property.isAdder()) { + // write adder + writer.print("\n"); + + if (property.getDoc() != null) { + writer.print(" /**\n"); + writer.printf(" *%s\n", property.getDoc().toString().replace("\n", "\n * ")); + writer.print(" */\n"); + } + writer.printf(" %s(%s: %s): %s;\n", property.getAdderMethod(), entry.getKey(), genType(property.getType()), model.getType().getRaw().getSimpleName()); + } + + more = true; + } + + writer.print("}\n"); + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/OptionsJS.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/OptionsJS.java new file mode 100644 index 000000000..543302148 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/OptionsJS.java @@ -0,0 +1,71 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.DataObjectModel; +import io.vertx.codegen.Generator; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Map; + +import static io.reactiverse.es4x.codegen.generator.Util.getNPMScope; + +public class OptionsJS extends Generator { + + public OptionsJS() { + incremental = true; + + kinds = new HashSet<>(); + kinds.add("dataObject"); + + name = "es4x-generator (options.js)"; + } + + @Override + public String filename(DataObjectModel model) { + return "npm/options.js"; + } + + @Override + public String render(DataObjectModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + if (index == 0) { + Util.generateLicense(writer); + + writer.printf("/// \n", getNPMScope(model.getType().getRaw().getModule())); + writer.print("module.exports = {\n"); + } + + writer.printf(" %s: Java.type('%s')", model.getType().getRaw().getSimpleName(), model.getType().getName()); + + if (index != size - 1) { + writer.print(','); + } + + writer.print('\n'); + + if (index == size - 1) { + writer.print("};\n"); + } + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/PackageJSON.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/PackageJSON.java new file mode 100644 index 000000000..6d7a241d7 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/PackageJSON.java @@ -0,0 +1,89 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.Generator; +import io.vertx.codegen.ModuleModel; +import io.vertx.core.json.JsonObject; + +import java.util.HashSet; +import java.util.Map; + +import static io.reactiverse.es4x.codegen.generator.Util.getNPMScope; + +public class PackageJSON extends Generator { + + public PackageJSON() { + kinds = new HashSet<>(); + kinds.add("module"); + + name = "es4x-generator (package.json)"; + } + + @Override + public String filename(ModuleModel model) { + return "npm/package.json"; + } + + @Override + public String render(ModuleModel model, int index, int size, Map session) { + + /* attempt to merge from the environment config */ + JsonObject json = new JsonObject(System.getProperty("package-json", "{}")); + + if (json.getString("name") == null || json.getString("name").equals("")) { + json.put("name", getNPMScope(model.getModule())); + } + + if (!Boolean.getBoolean("npm-meta-package")) { + /* always overwritten */ + json.put("main", "index.js"); + json.put("types", "index.d.ts"); + } + + // extras + json.put("sideEffects", false); + + // fix version(s) + json.put("version", toSemVer(json.getString("version"))); + if (json.containsKey("dependencies")) { + for (Map.Entry kv : json.getJsonObject("dependencies")) { + kv.setValue(toSemVer((String) kv.getValue())); + } + } + + return json.encodePrettily(); + } + + private String toSemVer(String string) { + char[] version = string.toCharArray(); + int dots = 0; + for (int i = 0; i < version.length; i++) { + if (version[i] == '.') { + dots++; + if (dots > 2) { + version[i] = '-'; + } + } + } + + if (dots > 2) { + return new String(version); + } + + return string; + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/ReadmeMD.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/ReadmeMD.java new file mode 100644 index 000000000..526041263 --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/ReadmeMD.java @@ -0,0 +1,98 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.Generator; +import io.vertx.codegen.ModuleModel; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Map; + +import static io.reactiverse.es4x.codegen.generator.Util.*; + +public class ReadmeMD extends Generator { + + public ReadmeMD() { + kinds = new HashSet<>(); + kinds.add("module"); + + name = "es4x-generator (README.md)"; + } + + @Override + public String filename(ModuleModel model) { + return "npm/README.md"; + } + + @Override + public String render(ModuleModel model, int index, int size, Map session) { + + StringWriter sw = new StringWriter(); + PrintWriter writer = new PrintWriter(sw); + + writer.printf("![npm (scoped)](https://img.shields.io/npm/v/%s.svg)\n", getNPMScope(model.getModule())); + writer.printf("![npm](https://img.shields.io/npm/l/%s.svg)\n", getNPMScope(model.getModule())); + writer.print("\n"); + writer.print("Generated JavaScript bindings for Eclipse Vert.x.\n"); + writer.print("\n"); + writer.print("## Documentation\n"); + writer.print("\n"); + writer.printf("* [API Docs](https://reactiverse.io/es4x/%s)\n", getNPMScope(model.getModule())); + writer.printf("* [NPM module](https://www.npmjs.com/package/%s)\n", getNPMScope(model.getModule())); + writer.print("\n"); + writer.print("## Usage\n"); + writer.print("\n"); + writer.print("Import the required `API`/`Enum`/`DataObject` and profit!\n"); + writer.print("\n"); + writer.print("```js\n"); + writer.print("// Base API\n"); + writer.printf("const Api = require('%s');\n", getNPMScope(model.getModule())); + writer.print("// Base ENUMs\n"); + writer.printf("const Enums = require('%s/enums');\n", getNPMScope(model.getModule())); + writer.print("// DataObject's\n"); + writer.printf("const Options = require('%s/options');\n", getNPMScope(model.getModule())); + writer.print("\n"); + writer.print("// refer to the API docs for specific help...\n"); + writer.print("\n"); + writer.print("// your code here!!!\n"); + writer.print("\n"); + writer.print("```\n"); + writer.print("\n"); + writer.print("## Typescript\n"); + writer.print("\n"); + writer.print("This package includes [Typescript](http://www.typescriptlang.org/) type"); + writer.print("definitions and your IDE should find then automatically.\n"); + writer.print("\n"); + writer.print("When working in a project you can enable type hinting for the runtime as:\n"); + writer.print("\n"); + writer.print("```js\n"); + writer.print("/// \n"); + writer.print("// @ts-check\n"); + writer.print("\n"); + writer.print("// your TypeScript code here...\n"); + writer.print("```\n"); + writer.print("\n"); + writer.print(includeFileIfPresent("MANUAL.md")); + writer.print("## Links\n"); + writer.print("\n"); + writer.print("* [Eclipse Vert.x](https://vertx.io)\n"); + writer.print("* [ES4X](https://reactiverse.io/es4x)\n"); + + return sw.toString(); + } +} diff --git a/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/Util.java b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/Util.java new file mode 100644 index 000000000..4ef8aae6c --- /dev/null +++ b/codegen/src/main/java/io/reactiverse/es4x/codegen/generator/Util.java @@ -0,0 +1,269 @@ +/* + * Copyright 2018 Paulo Lopes. + * + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * and Apache License v2.0 which accompanies this distribution. + * + * The Eclipse Public License is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * The Apache License v2.0 is available at + * http://www.opensource.org/licenses/apache2.0.php + * + * You may elect to redistribute this code under either of these licenses. + */ +package io.reactiverse.es4x.codegen.generator; + +import io.vertx.codegen.ModuleInfo; +import io.vertx.codegen.TypeParamInfo; +import io.vertx.codegen.type.*; +import io.vertx.core.json.JsonArray; +import io.vertx.core.json.JsonObject; + +import java.io.File; +import java.io.IOException; +import java.io.PrintWriter; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.util.Calendar; +import java.util.List; +import java.util.Map; + +public final class Util { + + private Util () { + throw new RuntimeException("Static Class"); + } + + private final static JsonArray registry; + private final static int year; + + static { + /* parse the registry from the system property */ + registry = new JsonArray(System.getProperty("scope-registry", "[]")); + year = Calendar.getInstance().get(Calendar.YEAR); + } + + public static String genType(TypeInfo type) { + + switch (type.getKind()) { + case STRING: + return "string"; + case BOXED_PRIMITIVE: + case PRIMITIVE: + switch (type.getSimpleName()) { + case "boolean": + case "Boolean": + return "boolean"; + case "char": + case "Character": + return "string"; + default: + return "number"; + } + case ENUM: + if (type.getRaw().getModule() != null) { + return type.getSimpleName(); + } else { + return "any"; + } + case OBJECT: + if (type.isVariable()) { + return type.getName(); + } else { + return "any"; + } + case JSON_OBJECT: + return "{ [key: string]: any }"; + case JSON_ARRAY: + return "any[]"; + case THROWABLE: + return "Error"; + case VOID: + return "void"; + case LIST: + case SET: + if (type.isParameterized()) { + return genType(((ParameterizedTypeInfo) type).getArg(0)) + "[]"; + } else { + return "any[]"; + } + case MAP: + if (type.isParameterized()) { + return "{ [key: " + genType(((ParameterizedTypeInfo) type).getArg(0)) + "]: " + genType(((ParameterizedTypeInfo) type).getArg(1)) + "; }"; + } else { + return "{ [key: string]: any }"; + } + case API: + StringBuilder sb = new StringBuilder(); + boolean first = true; + if (type.isParameterized()) { + for (TypeInfo t : ((ParameterizedTypeInfo) type).getArgs()) { + if (!first) { + sb.append(", "); + } + sb.append(genType(t)); + first = false; + } + return type.getRaw().getSimpleName() + "<" + sb.toString() + ">"; + } else { + // TS is strict with generics, you can't define/use a generic type with out its generic + if (type.getRaw() != null && type.getRaw().getParams().size() > 0) { + for (TypeParamInfo t : type.getRaw().getParams()) { + if (!first) { + sb.append(", "); + } + sb.append("any"); + first = false; + } + return type.getSimpleName() + "<" + sb.toString() + ">"; + } else { + return type.getErased().getSimpleName(); + } + } + case DATA_OBJECT: + return type.getErased().getSimpleName(); + case HANDLER: + if (type.isParameterized()) { + return "(res: " + genType(((ParameterizedTypeInfo) type).getArg(0)) + ") => void | Handler<" + genType(((ParameterizedTypeInfo) type).getArg(0)) + ">"; + } else { + return "(res: any) => void | Handler"; + } + case FUNCTION: + if (type.isParameterized()) { + return "(arg: " + genType(((ParameterizedTypeInfo) type).getArg(0)) + ") => " + genType(((ParameterizedTypeInfo) type).getArg(1)); + } else { + return "(arg: any) => any"; + } + case ASYNC_RESULT: + if (type.isParameterized()) { + return "AsyncResult<" + genType(((ParameterizedTypeInfo) type).getArg(0)) + ">"; + } else { + return "AsyncResult"; + } + case CLASS_TYPE: + return "any /* TODO: class */"; + case OTHER: + return "any /* TODO: other */"; + } + + System.out.println("!!! " + type + " - " + type.getKind()); + return ""; + } + + public static String genGeneric(List params) { + StringBuilder sb = new StringBuilder(); + + if (params.size() > 0) { + sb.append("<"); + boolean firstParam = true; + for (TypeParamInfo p : params) { + if (!firstParam) { + sb.append(", "); + } + sb.append(p.getName()); + firstParam = false; + } + sb.append(">"); + } + + return sb.toString(); + } + + public static boolean isImported(TypeInfo ref, Map session) { + if (ref.getRaw().getModuleName() == null) { + return true; + } + + final String key = ref.getRaw().getModuleName() + "/" + ref.getSimpleName(); + + if (!session.containsKey(key)) { + session.put(key, ref); + return false; + } + + return true; + } + + public static String getNPMScope(ModuleInfo module) { + + String scope = ""; + String name = ""; + + /* get from registry */ + for (Object el : registry) { + JsonObject entry = (JsonObject) el; + + if (entry.getString("group").equals(module.getGroupPackage())) { + scope = entry.getString("scope", ""); + if (scope.charAt(0) != '@') { + scope = "@" + scope; + } + if (scope.charAt(scope.length() - 1) != '/') { + scope += "/"; + } + if (entry.containsKey("prefix")) { + if (module.getName().startsWith(entry.getString("prefix"))) { + if (entry.getBoolean("stripPrefix")) { + name = module.getName().substring(entry.getString("prefix").length()); + } else { + name = module.getName(); + } + } + } + if (entry.containsKey("module")) { + if (module.getName().equals(entry.getString("module"))) { + name = entry.getString("name"); + } + } + } + } + + if (name.equals("")) { + name = module.getName(); + } + + return scope + name; + } + + public static String includeFileIfPresent(String file) { + final File path = new File(System.getProperty("basedir"), file); + if (path.exists()) { + try { + byte[] bytes = Files.readAllBytes(path.toPath()); + String md = new String(bytes, StandardCharsets.UTF_8); + if (md.length() > 0) { + if (md.charAt(md.length() - 1) != '\n') { + return md + "\n\n"; + } else { + return md + "\n"; + } + } + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + return ""; + } + + public static void generateLicense(PrintWriter writer) { + writer.println("/*"); + writer.println(" * Copyright " + year + " ES4X"); + writer.println(" *"); + writer.println(" * ES4X licenses this file to you under the Apache License, version 2.0"); + writer.println(" * (the \"License\"); you may not use this file except in compliance with the"); + writer.println(" * License. You may obtain a copy of the License at:"); + writer.println(" *"); + writer.println(" * http://www.apache.org/licenses/LICENSE-2.0"); + writer.println(" *"); + writer.println(" * Unless required by applicable law or agreed to in writing, software"); + writer.println(" * distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT"); + writer.println(" * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the"); + writer.println(" * License for the specific language governing permissions and limitations"); + writer.println(" * under the License."); + writer.println(" */"); + writer.println(); + } +} diff --git a/codegen/src/main/resources/META-INF/services/io.vertx.codegen.GeneratorLoader b/codegen/src/main/resources/META-INF/services/io.vertx.codegen.GeneratorLoader new file mode 100644 index 000000000..96d796255 --- /dev/null +++ b/codegen/src/main/resources/META-INF/services/io.vertx.codegen.GeneratorLoader @@ -0,0 +1 @@ +io.reactiverse.es4x.codegen.ES4XGeneratorLoader diff --git a/docs/@reactiverse/reactive-pg-client/assets/js/search.js b/docs/@reactiverse/reactive-pg-client/assets/js/search.js index 1c5702145..92e08b570 100644 --- a/docs/@reactiverse/reactive-pg-client/assets/js/search.js +++ b/docs/@reactiverse/reactive-pg-client/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"Interval","url":"classes/interval.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"days","url":"classes/interval.html#days","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":2,"kind":1024,"name":"hours","url":"classes/interval.html#hours","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":3,"kind":1024,"name":"microseconds","url":"classes/interval.html#microseconds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":4,"kind":1024,"name":"minutes","url":"classes/interval.html#minutes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":5,"kind":1024,"name":"months","url":"classes/interval.html#months","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":6,"kind":1024,"name":"seconds","url":"classes/interval.html#seconds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":7,"kind":1024,"name":"years","url":"classes/interval.html#years","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Interval"},{"id":8,"kind":128,"name":"PgConnectOptions","url":"classes/pgconnectoptions.html","classes":"tsd-kind-class"},{"id":9,"kind":1024,"name":"cachePreparedStatements","url":"classes/pgconnectoptions.html#cachepreparedstatements","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":10,"kind":1024,"name":"connectTimeout","url":"classes/pgconnectoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":11,"kind":1024,"name":"crlPaths","url":"classes/pgconnectoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":12,"kind":1024,"name":"crlValues","url":"classes/pgconnectoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":13,"kind":1024,"name":"database","url":"classes/pgconnectoptions.html#database","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":14,"kind":1024,"name":"enabledCipherSuites","url":"classes/pgconnectoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":15,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/pgconnectoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":16,"kind":1024,"name":"host","url":"classes/pgconnectoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":17,"kind":1024,"name":"hostnameVerificationAlgorithm","url":"classes/pgconnectoptions.html#hostnameverificationalgorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":18,"kind":1024,"name":"idleTimeout","url":"classes/pgconnectoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":19,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/pgconnectoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":20,"kind":1024,"name":"keyStoreOptions","url":"classes/pgconnectoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":21,"kind":1024,"name":"localAddress","url":"classes/pgconnectoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":22,"kind":1024,"name":"logActivity","url":"classes/pgconnectoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":23,"kind":1024,"name":"metricsName","url":"classes/pgconnectoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":24,"kind":1024,"name":"openSslEngineOptions","url":"classes/pgconnectoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":25,"kind":1024,"name":"password","url":"classes/pgconnectoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":26,"kind":1024,"name":"pemKeyCertOptions","url":"classes/pgconnectoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":27,"kind":1024,"name":"pemTrustOptions","url":"classes/pgconnectoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":28,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/pgconnectoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":29,"kind":1024,"name":"pfxTrustOptions","url":"classes/pgconnectoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":30,"kind":1024,"name":"pipeliningLimit","url":"classes/pgconnectoptions.html#pipelininglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":31,"kind":1024,"name":"port","url":"classes/pgconnectoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":32,"kind":1024,"name":"proxyOptions","url":"classes/pgconnectoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":33,"kind":1024,"name":"receiveBufferSize","url":"classes/pgconnectoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":34,"kind":1024,"name":"reconnectAttempts","url":"classes/pgconnectoptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":35,"kind":1024,"name":"reconnectInterval","url":"classes/pgconnectoptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":36,"kind":1024,"name":"reuseAddress","url":"classes/pgconnectoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":37,"kind":1024,"name":"reusePort","url":"classes/pgconnectoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":38,"kind":1024,"name":"sendBufferSize","url":"classes/pgconnectoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":39,"kind":1024,"name":"soLinger","url":"classes/pgconnectoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":40,"kind":1024,"name":"ssl","url":"classes/pgconnectoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":41,"kind":1024,"name":"tcpCork","url":"classes/pgconnectoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":42,"kind":1024,"name":"tcpFastOpen","url":"classes/pgconnectoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":43,"kind":1024,"name":"tcpKeepAlive","url":"classes/pgconnectoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":44,"kind":1024,"name":"tcpNoDelay","url":"classes/pgconnectoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":45,"kind":1024,"name":"tcpQuickAck","url":"classes/pgconnectoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":46,"kind":1024,"name":"trafficClass","url":"classes/pgconnectoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":47,"kind":1024,"name":"trustAll","url":"classes/pgconnectoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":48,"kind":1024,"name":"trustStoreOptions","url":"classes/pgconnectoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":49,"kind":1024,"name":"useAlpn","url":"classes/pgconnectoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":50,"kind":1024,"name":"usePooledBuffers","url":"classes/pgconnectoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":51,"kind":1024,"name":"user","url":"classes/pgconnectoptions.html#user","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":52,"kind":128,"name":"PgNotification","url":"classes/pgnotification.html","classes":"tsd-kind-class"},{"id":53,"kind":1024,"name":"channel","url":"classes/pgnotification.html#channel","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgNotification"},{"id":54,"kind":1024,"name":"payload","url":"classes/pgnotification.html#payload","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgNotification"},{"id":55,"kind":1024,"name":"processId","url":"classes/pgnotification.html#processid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgNotification"},{"id":56,"kind":128,"name":"PgPoolOptions","url":"classes/pgpooloptions.html","classes":"tsd-kind-class"},{"id":57,"kind":1024,"name":"cachePreparedStatements","url":"classes/pgpooloptions.html#cachepreparedstatements","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":58,"kind":1024,"name":"connectTimeout","url":"classes/pgpooloptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":59,"kind":1024,"name":"crlPaths","url":"classes/pgpooloptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":60,"kind":1024,"name":"crlValues","url":"classes/pgpooloptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":61,"kind":1024,"name":"database","url":"classes/pgpooloptions.html#database","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":62,"kind":1024,"name":"enabledCipherSuites","url":"classes/pgpooloptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":63,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/pgpooloptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":64,"kind":1024,"name":"host","url":"classes/pgpooloptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":65,"kind":1024,"name":"hostnameVerificationAlgorithm","url":"classes/pgpooloptions.html#hostnameverificationalgorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":66,"kind":1024,"name":"idleTimeout","url":"classes/pgpooloptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":67,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/pgpooloptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":68,"kind":1024,"name":"keyStoreOptions","url":"classes/pgpooloptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":69,"kind":1024,"name":"localAddress","url":"classes/pgpooloptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":70,"kind":1024,"name":"logActivity","url":"classes/pgpooloptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":71,"kind":1024,"name":"maxSize","url":"classes/pgpooloptions.html#maxsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":72,"kind":1024,"name":"maxWaitQueueSize","url":"classes/pgpooloptions.html#maxwaitqueuesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":73,"kind":1024,"name":"metricsName","url":"classes/pgpooloptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":74,"kind":1024,"name":"openSslEngineOptions","url":"classes/pgpooloptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":75,"kind":1024,"name":"password","url":"classes/pgpooloptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":76,"kind":1024,"name":"pemKeyCertOptions","url":"classes/pgpooloptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":77,"kind":1024,"name":"pemTrustOptions","url":"classes/pgpooloptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":78,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/pgpooloptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":79,"kind":1024,"name":"pfxTrustOptions","url":"classes/pgpooloptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":80,"kind":1024,"name":"pipeliningLimit","url":"classes/pgpooloptions.html#pipelininglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":81,"kind":1024,"name":"port","url":"classes/pgpooloptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":82,"kind":1024,"name":"proxyOptions","url":"classes/pgpooloptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":83,"kind":1024,"name":"receiveBufferSize","url":"classes/pgpooloptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":84,"kind":1024,"name":"reconnectAttempts","url":"classes/pgpooloptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":85,"kind":1024,"name":"reconnectInterval","url":"classes/pgpooloptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":86,"kind":1024,"name":"reuseAddress","url":"classes/pgpooloptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":87,"kind":1024,"name":"reusePort","url":"classes/pgpooloptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":88,"kind":1024,"name":"sendBufferSize","url":"classes/pgpooloptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":89,"kind":1024,"name":"soLinger","url":"classes/pgpooloptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":90,"kind":1024,"name":"ssl","url":"classes/pgpooloptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":91,"kind":1024,"name":"tcpCork","url":"classes/pgpooloptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":92,"kind":1024,"name":"tcpFastOpen","url":"classes/pgpooloptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":93,"kind":1024,"name":"tcpKeepAlive","url":"classes/pgpooloptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":94,"kind":1024,"name":"tcpNoDelay","url":"classes/pgpooloptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":95,"kind":1024,"name":"tcpQuickAck","url":"classes/pgpooloptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":96,"kind":1024,"name":"trafficClass","url":"classes/pgpooloptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":97,"kind":1024,"name":"trustAll","url":"classes/pgpooloptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":98,"kind":1024,"name":"trustStoreOptions","url":"classes/pgpooloptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":99,"kind":1024,"name":"useAlpn","url":"classes/pgpooloptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":100,"kind":1024,"name":"usePooledBuffers","url":"classes/pgpooloptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":101,"kind":1024,"name":"user","url":"classes/pgpooloptions.html#user","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":102,"kind":128,"name":"Point","url":"classes/point.html","classes":"tsd-kind-class"},{"id":103,"kind":1024,"name":"x","url":"classes/point.html#x","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Point"},{"id":104,"kind":1024,"name":"y","url":"classes/point.html#y","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Point"},{"id":105,"kind":128,"name":"Json","url":"classes/json.html","classes":"tsd-kind-class"},{"id":106,"kind":2048,"name":"create","url":"classes/json.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Json"},{"id":107,"kind":2048,"name":"value","url":"classes/json.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Json"},{"id":108,"kind":128,"name":"PgChannel","url":"classes/pgchannel.html","classes":"tsd-kind-class"},{"id":109,"kind":2048,"name":"subscribeHandler","url":"classes/pgchannel.html#subscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":110,"kind":2048,"name":"handler","url":"classes/pgchannel.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":111,"kind":2048,"name":"pause","url":"classes/pgchannel.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":112,"kind":2048,"name":"resume","url":"classes/pgchannel.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":113,"kind":2048,"name":"endHandler","url":"classes/pgchannel.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":114,"kind":2048,"name":"exceptionHandler","url":"classes/pgchannel.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":115,"kind":128,"name":"PgClient","url":"classes/pgclient.html","classes":"tsd-kind-class"},{"id":116,"kind":2048,"name":"pool","url":"classes/pgclient.html#pool","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PgClient"},{"id":117,"kind":2048,"name":"connect","url":"classes/pgclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PgClient"},{"id":118,"kind":2048,"name":"query","url":"classes/pgclient.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgClient"},{"id":119,"kind":2048,"name":"preparedQuery","url":"classes/pgclient.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgClient"},{"id":120,"kind":2048,"name":"preparedBatch","url":"classes/pgclient.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgClient"},{"id":121,"kind":128,"name":"PgConnection","url":"classes/pgconnection.html","classes":"tsd-kind-class"},{"id":122,"kind":2048,"name":"prepare","url":"classes/pgconnection.html#prepare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":123,"kind":2048,"name":"exceptionHandler","url":"classes/pgconnection.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":124,"kind":2048,"name":"closeHandler","url":"classes/pgconnection.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":125,"kind":2048,"name":"begin","url":"classes/pgconnection.html#begin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":126,"kind":2048,"name":"notificationHandler","url":"classes/pgconnection.html#notificationhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":127,"kind":2048,"name":"isSSL","url":"classes/pgconnection.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":128,"kind":2048,"name":"close","url":"classes/pgconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":129,"kind":2048,"name":"preparedQuery","url":"classes/pgconnection.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":130,"kind":2048,"name":"query","url":"classes/pgconnection.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":131,"kind":2048,"name":"preparedBatch","url":"classes/pgconnection.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":132,"kind":128,"name":"PgCursor","url":"classes/pgcursor.html","classes":"tsd-kind-class"},{"id":133,"kind":2048,"name":"read","url":"classes/pgcursor.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgCursor"},{"id":134,"kind":2048,"name":"hasMore","url":"classes/pgcursor.html#hasmore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgCursor"},{"id":135,"kind":2048,"name":"close","url":"classes/pgcursor.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgCursor"},{"id":136,"kind":128,"name":"PgIterator","url":"classes/pgiterator.html","classes":"tsd-kind-class"},{"id":137,"kind":2048,"name":"hasNext","url":"classes/pgiterator.html#hasnext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgIterator"},{"id":138,"kind":2048,"name":"next","url":"classes/pgiterator.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgIterator"},{"id":139,"kind":128,"name":"PgPool","url":"classes/pgpool.html","classes":"tsd-kind-class"},{"id":140,"kind":2048,"name":"preparedQuery","url":"classes/pgpool.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":141,"kind":2048,"name":"query","url":"classes/pgpool.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":142,"kind":2048,"name":"preparedBatch","url":"classes/pgpool.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":143,"kind":2048,"name":"getConnection","url":"classes/pgpool.html#getconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":144,"kind":2048,"name":"begin","url":"classes/pgpool.html#begin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":145,"kind":2048,"name":"close","url":"classes/pgpool.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":146,"kind":128,"name":"PgPreparedQuery","url":"classes/pgpreparedquery.html","classes":"tsd-kind-class"},{"id":147,"kind":2048,"name":"execute","url":"classes/pgpreparedquery.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":148,"kind":2048,"name":"cursor","url":"classes/pgpreparedquery.html#cursor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":149,"kind":2048,"name":"createStream","url":"classes/pgpreparedquery.html#createstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":150,"kind":2048,"name":"batch","url":"classes/pgpreparedquery.html#batch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":151,"kind":2048,"name":"close","url":"classes/pgpreparedquery.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":152,"kind":128,"name":"PgResult","url":"classes/pgresult.html","classes":"tsd-kind-class"},{"id":153,"kind":2048,"name":"rowCount","url":"classes/pgresult.html#rowcount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":154,"kind":2048,"name":"columnsNames","url":"classes/pgresult.html#columnsnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":155,"kind":2048,"name":"size","url":"classes/pgresult.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":156,"kind":2048,"name":"value","url":"classes/pgresult.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":157,"kind":2048,"name":"next","url":"classes/pgresult.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":158,"kind":128,"name":"PgRowSet","url":"classes/pgrowset.html","classes":"tsd-kind-class"},{"id":159,"kind":2048,"name":"value","url":"classes/pgrowset.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgRowSet"},{"id":160,"kind":2048,"name":"iterator","url":"classes/pgrowset.html#iterator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgRowSet"},{"id":161,"kind":2048,"name":"next","url":"classes/pgrowset.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgRowSet"},{"id":162,"kind":128,"name":"PgStream","url":"classes/pgstream.html","classes":"tsd-kind-class"},{"id":163,"kind":2048,"name":"exceptionHandler","url":"classes/pgstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":164,"kind":2048,"name":"handler","url":"classes/pgstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":165,"kind":2048,"name":"pause","url":"classes/pgstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":166,"kind":2048,"name":"resume","url":"classes/pgstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":167,"kind":2048,"name":"endHandler","url":"classes/pgstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":168,"kind":2048,"name":"close","url":"classes/pgstream.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":169,"kind":128,"name":"PgSubscriber","url":"classes/pgsubscriber.html","classes":"tsd-kind-class"},{"id":170,"kind":2048,"name":"subscriber","url":"classes/pgsubscriber.html#subscriber","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PgSubscriber"},{"id":171,"kind":2048,"name":"channel","url":"classes/pgsubscriber.html#channel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":172,"kind":2048,"name":"connect","url":"classes/pgsubscriber.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":173,"kind":2048,"name":"reconnectPolicy","url":"classes/pgsubscriber.html#reconnectpolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":174,"kind":2048,"name":"closeHandler","url":"classes/pgsubscriber.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":175,"kind":2048,"name":"actualConnection","url":"classes/pgsubscriber.html#actualconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":176,"kind":2048,"name":"closed","url":"classes/pgsubscriber.html#closed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":177,"kind":2048,"name":"close","url":"classes/pgsubscriber.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":178,"kind":128,"name":"PgTransaction","url":"classes/pgtransaction.html","classes":"tsd-kind-class"},{"id":179,"kind":2048,"name":"commit","url":"classes/pgtransaction.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":180,"kind":2048,"name":"rollback","url":"classes/pgtransaction.html#rollback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":181,"kind":2048,"name":"abortHandler","url":"classes/pgtransaction.html#aborthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":182,"kind":2048,"name":"query","url":"classes/pgtransaction.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":183,"kind":2048,"name":"preparedQuery","url":"classes/pgtransaction.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":184,"kind":2048,"name":"preparedBatch","url":"classes/pgtransaction.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":185,"kind":128,"name":"Row","url":"classes/row.html","classes":"tsd-kind-class"},{"id":186,"kind":2048,"name":"getColumnName","url":"classes/row.html#getcolumnname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":187,"kind":2048,"name":"getBoolean","url":"classes/row.html#getboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":188,"kind":2048,"name":"getValue","url":"classes/row.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":189,"kind":2048,"name":"getShort","url":"classes/row.html#getshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":190,"kind":2048,"name":"getInteger","url":"classes/row.html#getinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":191,"kind":2048,"name":"getLong","url":"classes/row.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":192,"kind":2048,"name":"getFloat","url":"classes/row.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":193,"kind":2048,"name":"getDouble","url":"classes/row.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":194,"kind":2048,"name":"getString","url":"classes/row.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":195,"kind":2048,"name":"getJson","url":"classes/row.html#getjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":196,"kind":2048,"name":"getBuffer","url":"classes/row.html#getbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":197,"kind":128,"name":"Tuple","url":"classes/tuple.html","classes":"tsd-kind-class"},{"id":198,"kind":2048,"name":"tuple","url":"classes/tuple.html#tuple-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Tuple"},{"id":199,"kind":2048,"name":"of","url":"classes/tuple.html#of","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Tuple"},{"id":200,"kind":2048,"name":"getBoolean","url":"classes/tuple.html#getboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":201,"kind":2048,"name":"getValue","url":"classes/tuple.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":202,"kind":2048,"name":"getShort","url":"classes/tuple.html#getshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":203,"kind":2048,"name":"getInteger","url":"classes/tuple.html#getinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":204,"kind":2048,"name":"getLong","url":"classes/tuple.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":205,"kind":2048,"name":"getFloat","url":"classes/tuple.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":206,"kind":2048,"name":"getDouble","url":"classes/tuple.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":207,"kind":2048,"name":"getString","url":"classes/tuple.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":208,"kind":2048,"name":"getJson","url":"classes/tuple.html#getjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":209,"kind":2048,"name":"getBuffer","url":"classes/tuple.html#getbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":210,"kind":2048,"name":"addBoolean","url":"classes/tuple.html#addboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":211,"kind":2048,"name":"addValue","url":"classes/tuple.html#addvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":212,"kind":2048,"name":"addShort","url":"classes/tuple.html#addshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":213,"kind":2048,"name":"addInteger","url":"classes/tuple.html#addinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":214,"kind":2048,"name":"addLong","url":"classes/tuple.html#addlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":215,"kind":2048,"name":"addFloat","url":"classes/tuple.html#addfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":216,"kind":2048,"name":"addDouble","url":"classes/tuple.html#adddouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":217,"kind":2048,"name":"addString","url":"classes/tuple.html#addstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":218,"kind":2048,"name":"addJson","url":"classes/tuple.html#addjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":219,"kind":2048,"name":"addBuffer","url":"classes/tuple.html#addbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":220,"kind":2048,"name":"size","url":"classes/tuple.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":221,"kind":2048,"name":"clear","url":"classes/tuple.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"Interval","url":"classes/interval.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/interval.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Interval"},{"id":2,"kind":2048,"name":"getDays","url":"classes/interval.html#getdays","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":3,"kind":2048,"name":"setDays","url":"classes/interval.html#setdays","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":4,"kind":2048,"name":"getHours","url":"classes/interval.html#gethours","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":5,"kind":2048,"name":"setHours","url":"classes/interval.html#sethours","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":6,"kind":2048,"name":"getMicroseconds","url":"classes/interval.html#getmicroseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":7,"kind":2048,"name":"setMicroseconds","url":"classes/interval.html#setmicroseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":8,"kind":2048,"name":"getMinutes","url":"classes/interval.html#getminutes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":9,"kind":2048,"name":"setMinutes","url":"classes/interval.html#setminutes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":10,"kind":2048,"name":"getMonths","url":"classes/interval.html#getmonths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":11,"kind":2048,"name":"setMonths","url":"classes/interval.html#setmonths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":12,"kind":2048,"name":"getSeconds","url":"classes/interval.html#getseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":13,"kind":2048,"name":"setSeconds","url":"classes/interval.html#setseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":14,"kind":2048,"name":"getYears","url":"classes/interval.html#getyears","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":15,"kind":2048,"name":"setYears","url":"classes/interval.html#setyears","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Interval"},{"id":16,"kind":128,"name":"PgConnectOptions","url":"classes/pgconnectoptions.html","classes":"tsd-kind-class"},{"id":17,"kind":512,"name":"constructor","url":"classes/pgconnectoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":18,"kind":2048,"name":"getCachePreparedStatements","url":"classes/pgconnectoptions.html#getcachepreparedstatements","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":19,"kind":2048,"name":"setCachePreparedStatements","url":"classes/pgconnectoptions.html#setcachepreparedstatements","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":20,"kind":2048,"name":"getConnectTimeout","url":"classes/pgconnectoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":21,"kind":2048,"name":"setConnectTimeout","url":"classes/pgconnectoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":22,"kind":2048,"name":"getCrlPaths","url":"classes/pgconnectoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":23,"kind":2048,"name":"addCrlPath","url":"classes/pgconnectoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":24,"kind":2048,"name":"getCrlValues","url":"classes/pgconnectoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":25,"kind":2048,"name":"addCrlValue","url":"classes/pgconnectoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":26,"kind":2048,"name":"getDatabase","url":"classes/pgconnectoptions.html#getdatabase","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":27,"kind":2048,"name":"setDatabase","url":"classes/pgconnectoptions.html#setdatabase","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":28,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/pgconnectoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":29,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/pgconnectoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":30,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/pgconnectoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":31,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/pgconnectoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":32,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/pgconnectoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":33,"kind":2048,"name":"getHost","url":"classes/pgconnectoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":34,"kind":2048,"name":"setHost","url":"classes/pgconnectoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":35,"kind":2048,"name":"getHostnameVerificationAlgorithm","url":"classes/pgconnectoptions.html#gethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":36,"kind":2048,"name":"setHostnameVerificationAlgorithm","url":"classes/pgconnectoptions.html#sethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":37,"kind":2048,"name":"getIdleTimeout","url":"classes/pgconnectoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":38,"kind":2048,"name":"setIdleTimeout","url":"classes/pgconnectoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":39,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/pgconnectoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":40,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/pgconnectoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":41,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/pgconnectoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":42,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/pgconnectoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":43,"kind":2048,"name":"getKeyStoreOptions","url":"classes/pgconnectoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":44,"kind":2048,"name":"setKeyStoreOptions","url":"classes/pgconnectoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":45,"kind":2048,"name":"getLocalAddress","url":"classes/pgconnectoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":46,"kind":2048,"name":"setLocalAddress","url":"classes/pgconnectoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":47,"kind":2048,"name":"getLogActivity","url":"classes/pgconnectoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":48,"kind":2048,"name":"setLogActivity","url":"classes/pgconnectoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":49,"kind":2048,"name":"getMetricsName","url":"classes/pgconnectoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":50,"kind":2048,"name":"setMetricsName","url":"classes/pgconnectoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":51,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/pgconnectoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":52,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/pgconnectoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":53,"kind":2048,"name":"getPassword","url":"classes/pgconnectoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":54,"kind":2048,"name":"setPassword","url":"classes/pgconnectoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":55,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/pgconnectoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":56,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/pgconnectoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":57,"kind":2048,"name":"getPemTrustOptions","url":"classes/pgconnectoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":58,"kind":2048,"name":"setPemTrustOptions","url":"classes/pgconnectoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":59,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/pgconnectoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":60,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/pgconnectoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":61,"kind":2048,"name":"getPfxTrustOptions","url":"classes/pgconnectoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":62,"kind":2048,"name":"setPfxTrustOptions","url":"classes/pgconnectoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":63,"kind":2048,"name":"getPipeliningLimit","url":"classes/pgconnectoptions.html#getpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":64,"kind":2048,"name":"setPipeliningLimit","url":"classes/pgconnectoptions.html#setpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":65,"kind":2048,"name":"getPort","url":"classes/pgconnectoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":66,"kind":2048,"name":"setPort","url":"classes/pgconnectoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":67,"kind":2048,"name":"getProxyOptions","url":"classes/pgconnectoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":68,"kind":2048,"name":"setProxyOptions","url":"classes/pgconnectoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":69,"kind":2048,"name":"getReceiveBufferSize","url":"classes/pgconnectoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":70,"kind":2048,"name":"setReceiveBufferSize","url":"classes/pgconnectoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":71,"kind":2048,"name":"getReconnectAttempts","url":"classes/pgconnectoptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":72,"kind":2048,"name":"setReconnectAttempts","url":"classes/pgconnectoptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":73,"kind":2048,"name":"getReconnectInterval","url":"classes/pgconnectoptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":74,"kind":2048,"name":"setReconnectInterval","url":"classes/pgconnectoptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":75,"kind":2048,"name":"isReuseAddress","url":"classes/pgconnectoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":76,"kind":2048,"name":"setReuseAddress","url":"classes/pgconnectoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":77,"kind":2048,"name":"isReusePort","url":"classes/pgconnectoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":78,"kind":2048,"name":"setReusePort","url":"classes/pgconnectoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":79,"kind":2048,"name":"getSendBufferSize","url":"classes/pgconnectoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":80,"kind":2048,"name":"setSendBufferSize","url":"classes/pgconnectoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":81,"kind":2048,"name":"getSoLinger","url":"classes/pgconnectoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":82,"kind":2048,"name":"setSoLinger","url":"classes/pgconnectoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":83,"kind":2048,"name":"isSsl","url":"classes/pgconnectoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":84,"kind":2048,"name":"setSsl","url":"classes/pgconnectoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":85,"kind":2048,"name":"isTcpCork","url":"classes/pgconnectoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":86,"kind":2048,"name":"setTcpCork","url":"classes/pgconnectoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":87,"kind":2048,"name":"isTcpFastOpen","url":"classes/pgconnectoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":88,"kind":2048,"name":"setTcpFastOpen","url":"classes/pgconnectoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":89,"kind":2048,"name":"isTcpKeepAlive","url":"classes/pgconnectoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":90,"kind":2048,"name":"setTcpKeepAlive","url":"classes/pgconnectoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":91,"kind":2048,"name":"isTcpNoDelay","url":"classes/pgconnectoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":92,"kind":2048,"name":"setTcpNoDelay","url":"classes/pgconnectoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":93,"kind":2048,"name":"isTcpQuickAck","url":"classes/pgconnectoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":94,"kind":2048,"name":"setTcpQuickAck","url":"classes/pgconnectoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":95,"kind":2048,"name":"getTrafficClass","url":"classes/pgconnectoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":96,"kind":2048,"name":"setTrafficClass","url":"classes/pgconnectoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":97,"kind":2048,"name":"isTrustAll","url":"classes/pgconnectoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":98,"kind":2048,"name":"setTrustAll","url":"classes/pgconnectoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":99,"kind":2048,"name":"getTrustStoreOptions","url":"classes/pgconnectoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":100,"kind":2048,"name":"setTrustStoreOptions","url":"classes/pgconnectoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":101,"kind":2048,"name":"isUseAlpn","url":"classes/pgconnectoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":102,"kind":2048,"name":"setUseAlpn","url":"classes/pgconnectoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":103,"kind":2048,"name":"isUsePooledBuffers","url":"classes/pgconnectoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":104,"kind":2048,"name":"setUsePooledBuffers","url":"classes/pgconnectoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":105,"kind":2048,"name":"getUser","url":"classes/pgconnectoptions.html#getuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":106,"kind":2048,"name":"setUser","url":"classes/pgconnectoptions.html#setuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":107,"kind":2048,"name":"isUsingDomainSocket","url":"classes/pgconnectoptions.html#isusingdomainsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnectOptions"},{"id":108,"kind":128,"name":"PgNotification","url":"classes/pgnotification.html","classes":"tsd-kind-class"},{"id":109,"kind":512,"name":"constructor","url":"classes/pgnotification.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PgNotification"},{"id":110,"kind":2048,"name":"getChannel","url":"classes/pgnotification.html#getchannel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgNotification"},{"id":111,"kind":2048,"name":"setChannel","url":"classes/pgnotification.html#setchannel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgNotification"},{"id":112,"kind":2048,"name":"getPayload","url":"classes/pgnotification.html#getpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgNotification"},{"id":113,"kind":2048,"name":"setPayload","url":"classes/pgnotification.html#setpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgNotification"},{"id":114,"kind":2048,"name":"getProcessId","url":"classes/pgnotification.html#getprocessid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgNotification"},{"id":115,"kind":2048,"name":"setProcessId","url":"classes/pgnotification.html#setprocessid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgNotification"},{"id":116,"kind":128,"name":"PgPoolOptions","url":"classes/pgpooloptions.html","classes":"tsd-kind-class"},{"id":117,"kind":512,"name":"constructor","url":"classes/pgpooloptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":118,"kind":2048,"name":"getCachePreparedStatements","url":"classes/pgpooloptions.html#getcachepreparedstatements","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":119,"kind":2048,"name":"setCachePreparedStatements","url":"classes/pgpooloptions.html#setcachepreparedstatements","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":120,"kind":2048,"name":"getConnectTimeout","url":"classes/pgpooloptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":121,"kind":2048,"name":"setConnectTimeout","url":"classes/pgpooloptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":122,"kind":2048,"name":"getCrlPaths","url":"classes/pgpooloptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":123,"kind":2048,"name":"addCrlPath","url":"classes/pgpooloptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":124,"kind":2048,"name":"getCrlValues","url":"classes/pgpooloptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":125,"kind":2048,"name":"addCrlValue","url":"classes/pgpooloptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":126,"kind":2048,"name":"getDatabase","url":"classes/pgpooloptions.html#getdatabase","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":127,"kind":2048,"name":"setDatabase","url":"classes/pgpooloptions.html#setdatabase","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":128,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/pgpooloptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":129,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/pgpooloptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":130,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/pgpooloptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":131,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/pgpooloptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":132,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/pgpooloptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":133,"kind":2048,"name":"getHost","url":"classes/pgpooloptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":134,"kind":2048,"name":"setHost","url":"classes/pgpooloptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":135,"kind":2048,"name":"getHostnameVerificationAlgorithm","url":"classes/pgpooloptions.html#gethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":136,"kind":2048,"name":"setHostnameVerificationAlgorithm","url":"classes/pgpooloptions.html#sethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":137,"kind":2048,"name":"getIdleTimeout","url":"classes/pgpooloptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":138,"kind":2048,"name":"setIdleTimeout","url":"classes/pgpooloptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":139,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/pgpooloptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":140,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/pgpooloptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":141,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/pgpooloptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":142,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/pgpooloptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":143,"kind":2048,"name":"getKeyStoreOptions","url":"classes/pgpooloptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":144,"kind":2048,"name":"setKeyStoreOptions","url":"classes/pgpooloptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":145,"kind":2048,"name":"getLocalAddress","url":"classes/pgpooloptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":146,"kind":2048,"name":"setLocalAddress","url":"classes/pgpooloptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":147,"kind":2048,"name":"getLogActivity","url":"classes/pgpooloptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":148,"kind":2048,"name":"setLogActivity","url":"classes/pgpooloptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":149,"kind":2048,"name":"getMaxSize","url":"classes/pgpooloptions.html#getmaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":150,"kind":2048,"name":"setMaxSize","url":"classes/pgpooloptions.html#setmaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":151,"kind":2048,"name":"getMaxWaitQueueSize","url":"classes/pgpooloptions.html#getmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":152,"kind":2048,"name":"setMaxWaitQueueSize","url":"classes/pgpooloptions.html#setmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":153,"kind":2048,"name":"getMetricsName","url":"classes/pgpooloptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":154,"kind":2048,"name":"setMetricsName","url":"classes/pgpooloptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":155,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/pgpooloptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":156,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/pgpooloptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":157,"kind":2048,"name":"getPassword","url":"classes/pgpooloptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":158,"kind":2048,"name":"setPassword","url":"classes/pgpooloptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":159,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/pgpooloptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":160,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/pgpooloptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":161,"kind":2048,"name":"getPemTrustOptions","url":"classes/pgpooloptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":162,"kind":2048,"name":"setPemTrustOptions","url":"classes/pgpooloptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":163,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/pgpooloptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":164,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/pgpooloptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":165,"kind":2048,"name":"getPfxTrustOptions","url":"classes/pgpooloptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":166,"kind":2048,"name":"setPfxTrustOptions","url":"classes/pgpooloptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":167,"kind":2048,"name":"getPipeliningLimit","url":"classes/pgpooloptions.html#getpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":168,"kind":2048,"name":"setPipeliningLimit","url":"classes/pgpooloptions.html#setpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":169,"kind":2048,"name":"getPort","url":"classes/pgpooloptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":170,"kind":2048,"name":"setPort","url":"classes/pgpooloptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":171,"kind":2048,"name":"getProxyOptions","url":"classes/pgpooloptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":172,"kind":2048,"name":"setProxyOptions","url":"classes/pgpooloptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":173,"kind":2048,"name":"getReceiveBufferSize","url":"classes/pgpooloptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":174,"kind":2048,"name":"setReceiveBufferSize","url":"classes/pgpooloptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":175,"kind":2048,"name":"getReconnectAttempts","url":"classes/pgpooloptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":176,"kind":2048,"name":"setReconnectAttempts","url":"classes/pgpooloptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":177,"kind":2048,"name":"getReconnectInterval","url":"classes/pgpooloptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":178,"kind":2048,"name":"setReconnectInterval","url":"classes/pgpooloptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":179,"kind":2048,"name":"isReuseAddress","url":"classes/pgpooloptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":180,"kind":2048,"name":"setReuseAddress","url":"classes/pgpooloptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":181,"kind":2048,"name":"isReusePort","url":"classes/pgpooloptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":182,"kind":2048,"name":"setReusePort","url":"classes/pgpooloptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":183,"kind":2048,"name":"getSendBufferSize","url":"classes/pgpooloptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":184,"kind":2048,"name":"setSendBufferSize","url":"classes/pgpooloptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":185,"kind":2048,"name":"getSoLinger","url":"classes/pgpooloptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":186,"kind":2048,"name":"setSoLinger","url":"classes/pgpooloptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":187,"kind":2048,"name":"isSsl","url":"classes/pgpooloptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":188,"kind":2048,"name":"setSsl","url":"classes/pgpooloptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":189,"kind":2048,"name":"isTcpCork","url":"classes/pgpooloptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":190,"kind":2048,"name":"setTcpCork","url":"classes/pgpooloptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":191,"kind":2048,"name":"isTcpFastOpen","url":"classes/pgpooloptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":192,"kind":2048,"name":"setTcpFastOpen","url":"classes/pgpooloptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":193,"kind":2048,"name":"isTcpKeepAlive","url":"classes/pgpooloptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":194,"kind":2048,"name":"setTcpKeepAlive","url":"classes/pgpooloptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":195,"kind":2048,"name":"isTcpNoDelay","url":"classes/pgpooloptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":196,"kind":2048,"name":"setTcpNoDelay","url":"classes/pgpooloptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":197,"kind":2048,"name":"isTcpQuickAck","url":"classes/pgpooloptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":198,"kind":2048,"name":"setTcpQuickAck","url":"classes/pgpooloptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":199,"kind":2048,"name":"getTrafficClass","url":"classes/pgpooloptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":200,"kind":2048,"name":"setTrafficClass","url":"classes/pgpooloptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":201,"kind":2048,"name":"isTrustAll","url":"classes/pgpooloptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":202,"kind":2048,"name":"setTrustAll","url":"classes/pgpooloptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":203,"kind":2048,"name":"getTrustStoreOptions","url":"classes/pgpooloptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":204,"kind":2048,"name":"setTrustStoreOptions","url":"classes/pgpooloptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":205,"kind":2048,"name":"isUseAlpn","url":"classes/pgpooloptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":206,"kind":2048,"name":"setUseAlpn","url":"classes/pgpooloptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":207,"kind":2048,"name":"isUsePooledBuffers","url":"classes/pgpooloptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":208,"kind":2048,"name":"setUsePooledBuffers","url":"classes/pgpooloptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":209,"kind":2048,"name":"getUser","url":"classes/pgpooloptions.html#getuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":210,"kind":2048,"name":"setUser","url":"classes/pgpooloptions.html#setuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":211,"kind":2048,"name":"isUsingDomainSocket","url":"classes/pgpooloptions.html#isusingdomainsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPoolOptions"},{"id":212,"kind":128,"name":"Point","url":"classes/point.html","classes":"tsd-kind-class"},{"id":213,"kind":512,"name":"constructor","url":"classes/point.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Point"},{"id":214,"kind":2048,"name":"getX","url":"classes/point.html#getx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Point"},{"id":215,"kind":2048,"name":"setX","url":"classes/point.html#setx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Point"},{"id":216,"kind":2048,"name":"getY","url":"classes/point.html#gety","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Point"},{"id":217,"kind":2048,"name":"setY","url":"classes/point.html#sety","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Point"},{"id":218,"kind":128,"name":"Json","url":"classes/json.html","classes":"tsd-kind-class"},{"id":219,"kind":2048,"name":"create","url":"classes/json.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Json"},{"id":220,"kind":2048,"name":"value","url":"classes/json.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Json"},{"id":221,"kind":128,"name":"PgChannel","url":"classes/pgchannel.html","classes":"tsd-kind-class"},{"id":222,"kind":2048,"name":"fetch","url":"classes/pgchannel.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":223,"kind":2048,"name":"subscribeHandler","url":"classes/pgchannel.html#subscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":224,"kind":2048,"name":"handler","url":"classes/pgchannel.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":225,"kind":2048,"name":"pause","url":"classes/pgchannel.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":226,"kind":2048,"name":"resume","url":"classes/pgchannel.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":227,"kind":2048,"name":"endHandler","url":"classes/pgchannel.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":228,"kind":2048,"name":"exceptionHandler","url":"classes/pgchannel.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgChannel"},{"id":229,"kind":128,"name":"PgClient","url":"classes/pgclient.html","classes":"tsd-kind-class"},{"id":230,"kind":2048,"name":"pool","url":"classes/pgclient.html#pool","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PgClient"},{"id":231,"kind":2048,"name":"connect","url":"classes/pgclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PgClient"},{"id":232,"kind":2048,"name":"query","url":"classes/pgclient.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgClient"},{"id":233,"kind":2048,"name":"preparedQuery","url":"classes/pgclient.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgClient"},{"id":234,"kind":2048,"name":"preparedBatch","url":"classes/pgclient.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgClient"},{"id":235,"kind":128,"name":"PgConnection","url":"classes/pgconnection.html","classes":"tsd-kind-class"},{"id":236,"kind":2048,"name":"prepare","url":"classes/pgconnection.html#prepare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":237,"kind":2048,"name":"exceptionHandler","url":"classes/pgconnection.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":238,"kind":2048,"name":"closeHandler","url":"classes/pgconnection.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":239,"kind":2048,"name":"begin","url":"classes/pgconnection.html#begin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":240,"kind":2048,"name":"notificationHandler","url":"classes/pgconnection.html#notificationhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":241,"kind":2048,"name":"isSSL","url":"classes/pgconnection.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":242,"kind":2048,"name":"close","url":"classes/pgconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgConnection"},{"id":243,"kind":2048,"name":"preparedQuery","url":"classes/pgconnection.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgConnection"},{"id":244,"kind":2048,"name":"query","url":"classes/pgconnection.html#query","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgConnection"},{"id":245,"kind":2048,"name":"preparedBatch","url":"classes/pgconnection.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgConnection"},{"id":246,"kind":2048,"name":"pool","url":"classes/pgconnection.html#pool","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"PgConnection"},{"id":247,"kind":2048,"name":"connect","url":"classes/pgconnection.html#connect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"PgConnection"},{"id":248,"kind":128,"name":"PgCursor","url":"classes/pgcursor.html","classes":"tsd-kind-class"},{"id":249,"kind":2048,"name":"read","url":"classes/pgcursor.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgCursor"},{"id":250,"kind":2048,"name":"hasMore","url":"classes/pgcursor.html#hasmore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgCursor"},{"id":251,"kind":2048,"name":"close","url":"classes/pgcursor.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgCursor"},{"id":252,"kind":128,"name":"PgIterator","url":"classes/pgiterator.html","classes":"tsd-kind-class"},{"id":253,"kind":2048,"name":"hasNext","url":"classes/pgiterator.html#hasnext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgIterator"},{"id":254,"kind":2048,"name":"next","url":"classes/pgiterator.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgIterator"},{"id":255,"kind":128,"name":"PgPool","url":"classes/pgpool.html","classes":"tsd-kind-class"},{"id":256,"kind":2048,"name":"preparedQuery","url":"classes/pgpool.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgPool"},{"id":257,"kind":2048,"name":"query","url":"classes/pgpool.html#query","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgPool"},{"id":258,"kind":2048,"name":"preparedBatch","url":"classes/pgpool.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgPool"},{"id":259,"kind":2048,"name":"getConnection","url":"classes/pgpool.html#getconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":260,"kind":2048,"name":"begin","url":"classes/pgpool.html#begin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":261,"kind":2048,"name":"close","url":"classes/pgpool.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPool"},{"id":262,"kind":2048,"name":"pool","url":"classes/pgpool.html#pool","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"PgPool"},{"id":263,"kind":2048,"name":"connect","url":"classes/pgpool.html#connect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"PgPool"},{"id":264,"kind":128,"name":"PgPreparedQuery","url":"classes/pgpreparedquery.html","classes":"tsd-kind-class"},{"id":265,"kind":2048,"name":"execute","url":"classes/pgpreparedquery.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":266,"kind":2048,"name":"cursor","url":"classes/pgpreparedquery.html#cursor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":267,"kind":2048,"name":"createStream","url":"classes/pgpreparedquery.html#createstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":268,"kind":2048,"name":"batch","url":"classes/pgpreparedquery.html#batch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":269,"kind":2048,"name":"close","url":"classes/pgpreparedquery.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgPreparedQuery"},{"id":270,"kind":128,"name":"PgResult","url":"classes/pgresult.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":271,"kind":2048,"name":"rowCount","url":"classes/pgresult.html#rowcount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":272,"kind":2048,"name":"columnsNames","url":"classes/pgresult.html#columnsnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":273,"kind":2048,"name":"size","url":"classes/pgresult.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":274,"kind":2048,"name":"value","url":"classes/pgresult.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":275,"kind":2048,"name":"next","url":"classes/pgresult.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgResult"},{"id":276,"kind":128,"name":"PgRowSet","url":"classes/pgrowset.html","classes":"tsd-kind-class"},{"id":277,"kind":2048,"name":"value","url":"classes/pgrowset.html#value","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgRowSet"},{"id":278,"kind":2048,"name":"iterator","url":"classes/pgrowset.html#iterator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgRowSet"},{"id":279,"kind":2048,"name":"next","url":"classes/pgrowset.html#next","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgRowSet"},{"id":280,"kind":2048,"name":"rowCount","url":"classes/pgrowset.html#rowcount","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"PgRowSet"},{"id":281,"kind":2048,"name":"columnsNames","url":"classes/pgrowset.html#columnsnames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"PgRowSet"},{"id":282,"kind":2048,"name":"size","url":"classes/pgrowset.html#size","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"PgRowSet"},{"id":283,"kind":128,"name":"PgStream","url":"classes/pgstream.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":284,"kind":2048,"name":"fetch","url":"classes/pgstream.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":285,"kind":2048,"name":"exceptionHandler","url":"classes/pgstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":286,"kind":2048,"name":"handler","url":"classes/pgstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":287,"kind":2048,"name":"pause","url":"classes/pgstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":288,"kind":2048,"name":"resume","url":"classes/pgstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":289,"kind":2048,"name":"endHandler","url":"classes/pgstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":290,"kind":2048,"name":"close","url":"classes/pgstream.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgStream"},{"id":291,"kind":128,"name":"PgSubscriber","url":"classes/pgsubscriber.html","classes":"tsd-kind-class"},{"id":292,"kind":2048,"name":"subscriber","url":"classes/pgsubscriber.html#subscriber","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PgSubscriber"},{"id":293,"kind":2048,"name":"channel","url":"classes/pgsubscriber.html#channel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":294,"kind":2048,"name":"connect","url":"classes/pgsubscriber.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":295,"kind":2048,"name":"reconnectPolicy","url":"classes/pgsubscriber.html#reconnectpolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":296,"kind":2048,"name":"closeHandler","url":"classes/pgsubscriber.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":297,"kind":2048,"name":"actualConnection","url":"classes/pgsubscriber.html#actualconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":298,"kind":2048,"name":"closed","url":"classes/pgsubscriber.html#closed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":299,"kind":2048,"name":"close","url":"classes/pgsubscriber.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgSubscriber"},{"id":300,"kind":128,"name":"PgTransaction","url":"classes/pgtransaction.html","classes":"tsd-kind-class"},{"id":301,"kind":2048,"name":"prepare","url":"classes/pgtransaction.html#prepare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":302,"kind":2048,"name":"commit","url":"classes/pgtransaction.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":303,"kind":2048,"name":"rollback","url":"classes/pgtransaction.html#rollback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":304,"kind":2048,"name":"abortHandler","url":"classes/pgtransaction.html#aborthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PgTransaction"},{"id":305,"kind":2048,"name":"query","url":"classes/pgtransaction.html#query","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgTransaction"},{"id":306,"kind":2048,"name":"preparedQuery","url":"classes/pgtransaction.html#preparedquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgTransaction"},{"id":307,"kind":2048,"name":"preparedBatch","url":"classes/pgtransaction.html#preparedbatch","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"PgTransaction"},{"id":308,"kind":2048,"name":"pool","url":"classes/pgtransaction.html#pool","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"PgTransaction"},{"id":309,"kind":2048,"name":"connect","url":"classes/pgtransaction.html#connect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"PgTransaction"},{"id":310,"kind":128,"name":"Row","url":"classes/row.html","classes":"tsd-kind-class"},{"id":311,"kind":2048,"name":"getColumnName","url":"classes/row.html#getcolumnname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Row"},{"id":312,"kind":2048,"name":"getBoolean","url":"classes/row.html#getboolean","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":313,"kind":2048,"name":"getValue","url":"classes/row.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":314,"kind":2048,"name":"getShort","url":"classes/row.html#getshort","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":315,"kind":2048,"name":"getInteger","url":"classes/row.html#getinteger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":316,"kind":2048,"name":"getLong","url":"classes/row.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":317,"kind":2048,"name":"getFloat","url":"classes/row.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":318,"kind":2048,"name":"getDouble","url":"classes/row.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":319,"kind":2048,"name":"getString","url":"classes/row.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":320,"kind":2048,"name":"getJson","url":"classes/row.html#getjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":321,"kind":2048,"name":"getBuffer","url":"classes/row.html#getbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Row"},{"id":322,"kind":2048,"name":"tuple","url":"classes/row.html#tuple","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"Row"},{"id":323,"kind":2048,"name":"of","url":"classes/row.html#of","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"Row"},{"id":324,"kind":2048,"name":"addBoolean","url":"classes/row.html#addboolean","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":325,"kind":2048,"name":"addValue","url":"classes/row.html#addvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":326,"kind":2048,"name":"addShort","url":"classes/row.html#addshort","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":327,"kind":2048,"name":"addInteger","url":"classes/row.html#addinteger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":328,"kind":2048,"name":"addLong","url":"classes/row.html#addlong","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":329,"kind":2048,"name":"addFloat","url":"classes/row.html#addfloat","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":330,"kind":2048,"name":"addDouble","url":"classes/row.html#adddouble","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":331,"kind":2048,"name":"addString","url":"classes/row.html#addstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":332,"kind":2048,"name":"addJson","url":"classes/row.html#addjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":333,"kind":2048,"name":"addBuffer","url":"classes/row.html#addbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":334,"kind":2048,"name":"size","url":"classes/row.html#size","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":335,"kind":2048,"name":"clear","url":"classes/row.html#clear","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Row"},{"id":336,"kind":128,"name":"Tuple","url":"classes/tuple.html","classes":"tsd-kind-class"},{"id":337,"kind":2048,"name":"tuple","url":"classes/tuple.html#tuple-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Tuple"},{"id":338,"kind":2048,"name":"of","url":"classes/tuple.html#of","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Tuple"},{"id":339,"kind":2048,"name":"getBoolean","url":"classes/tuple.html#getboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":340,"kind":2048,"name":"getValue","url":"classes/tuple.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":341,"kind":2048,"name":"getShort","url":"classes/tuple.html#getshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":342,"kind":2048,"name":"getInteger","url":"classes/tuple.html#getinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":343,"kind":2048,"name":"getLong","url":"classes/tuple.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":344,"kind":2048,"name":"getFloat","url":"classes/tuple.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":345,"kind":2048,"name":"getDouble","url":"classes/tuple.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":346,"kind":2048,"name":"getString","url":"classes/tuple.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":347,"kind":2048,"name":"getJson","url":"classes/tuple.html#getjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":348,"kind":2048,"name":"getBuffer","url":"classes/tuple.html#getbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":349,"kind":2048,"name":"addBoolean","url":"classes/tuple.html#addboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":350,"kind":2048,"name":"addValue","url":"classes/tuple.html#addvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":351,"kind":2048,"name":"addShort","url":"classes/tuple.html#addshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":352,"kind":2048,"name":"addInteger","url":"classes/tuple.html#addinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":353,"kind":2048,"name":"addLong","url":"classes/tuple.html#addlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":354,"kind":2048,"name":"addFloat","url":"classes/tuple.html#addfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":355,"kind":2048,"name":"addDouble","url":"classes/tuple.html#adddouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":356,"kind":2048,"name":"addString","url":"classes/tuple.html#addstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":357,"kind":2048,"name":"addJson","url":"classes/tuple.html#addjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":358,"kind":2048,"name":"addBuffer","url":"classes/tuple.html#addbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":359,"kind":2048,"name":"size","url":"classes/tuple.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"},{"id":360,"kind":2048,"name":"clear","url":"classes/tuple.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tuple"}]}; \ No newline at end of file diff --git a/docs/@reactiverse/reactive-pg-client/classes/interval.html b/docs/@reactiverse/reactive-pg-client/classes/interval.html index 39692cc19..770ae9487 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/interval.html +++ b/docs/@reactiverse/reactive-pg-client/classes/interval.html @@ -77,91 +77,349 @@

Index

-

Properties

+

Constructors

+
+
+

Methods

+
-

Properties

-
- -

days

-
days: number
- +

Constructors

+
+ +

constructor

+ +
    +
  • + +

    Returns Interval

    +
    • +
  • + +

    Parameters

    + +

    Returns Interval

    +
    • +
-
- -

hours

-
hours: number
- +
+
+

Methods

+
+ +

getDays

+
    +
  • getDays(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
-
- -

microseconds

-
microseconds: number
- +
+ +

getHours

+
    +
  • getHours(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
-
- -

minutes

-
minutes: number
- +
+ +

getMicroseconds

+
    +
  • getMicroseconds(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
-
- -

months

-
months: number
- +
+ +

getMinutes

+
    +
  • getMinutes(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
-
- -

seconds

-
seconds: number
- +
+ +

getMonths

+
    +
  • getMonths(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
-
- -

years

-
years: number
- +
+ +

getSeconds

+
    +
  • getSeconds(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
+
+
+ +

getYears

+
    +
  • getYears(): number
    • +
+
    +
  • + +

    Returns number

    +
    • +
+
+
+ +

setDays

+ +
    +
  • + +

    Parameters

    +
      +
    • +
      days: number
      +
      • +
    +

    Returns Interval

    +
    • +
+
+
+ +

setHours

+ +
    +
  • + +

    Parameters

    +
      +
    • +
      hours: number
      +
      • +
    +

    Returns Interval

    +
    • +
+
+
+ +

setMicroseconds

+
    +
  • setMicroseconds(microseconds: number): Interval
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      microseconds: number
      +
      • +
    +

    Returns Interval

    +
    • +
+
+
+ +

setMinutes

+
    +
  • setMinutes(minutes: number): Interval
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      minutes: number
      +
      • +
    +

    Returns Interval

    +
    • +
+
+
+ +

setMonths

+
    +
  • setMonths(months: number): Interval
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      months: number
      +
      • +
    +

    Returns Interval

    +
    • +
+
+
+ +

setSeconds

+
    +
  • setSeconds(seconds: number): Interval
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      seconds: number
      +
      • +
    +

    Returns Interval

    +
    • +
+
+
+ +

setYears

+ +
    +
  • + +

    Parameters

    +
      +
    • +
      years: number
      +
      • +
    +

    Returns Interval

    +
    • +
@@ -180,26 +438,50 @@

years

  • Interval
    • @@ -238,13 +520,13 @@

    years

  • PgPreparedQuery
    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/classes/json.html b/docs/@reactiverse/reactive-pg-client/classes/json.html index f7b0d1e8c..2a08c70f1 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/json.html +++ b/docs/@reactiverse/reactive-pg-client/classes/json.html @@ -92,16 +92,16 @@

    Methods

    value

      -
    • value(): Object
      • +
    • value(): any
    • -

      Returns Object

      +

      Returns any

    • @@ -115,7 +115,7 @@

    Static create

  • Parameters

    @@ -188,13 +188,13 @@

    Returns PgPreparedQuery

    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgchannel.html b/docs/@reactiverse/reactive-pg-client/classes/pgchannel.html index cb51488d5..68bd81e0a 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgchannel.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgchannel.html @@ -72,6 +72,12 @@

    Hierarchy

    • +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -81,6 +87,7 @@

    Methods

    • endHandler
    • exceptionHandler
      • +
    • fetch
    • handler
    • pause
    • resume
      • @@ -102,12 +109,12 @@

      endHandler

    • -

      Set an handler to be called when no more notifications will be received.

      +

      Set an handler to be called when no more notifications will be received.

      Parameters

      @@ -120,17 +127,19 @@
      endHandler: function
        • -
        • (result: void): void | null | undefined
          • +
        • (res: void): void | Handler<void> | null | undefined

        • Parameters

          • -
            result: void
            +
            res: void

          Returns void + | + Handler<void> | null | @@ -157,7 +166,7 @@

          exceptionHandler

        • Parameters

          @@ -167,17 +176,19 @@
          handler: function
            • -
            • (result: Error): void | null | undefined
              • +
            • (res: Error): void | Handler<Error> | null | undefined

            • Parameters

              • -
                result: Error
                +
                res: Error

              Returns void + | + Handler<Error> | null | @@ -193,6 +204,29 @@

              Returns + +

              fetch

              +
                +
              • fetch(arg0: number): ReadStream<string>
                • +
              +
                +
              • + +

                Parameters

                +
                  +
                • +
                  arg0: number
                  +
                  • +
                +

                Returns ReadStream<string>

                +
                • +
              +

    handler

    @@ -203,12 +237,12 @@

    handler

  • -

    Set or unset an handler to be called when a the channel is notified by Postgres. +

    Set or unset an handler to be called when a the channel is notified by Postgres.

    • when the handler is set, the subscriber sends a {@code LISTEN} command if needed
      • @@ -226,17 +260,19 @@
      handler: function
        • -
        • (result: string): void | null | undefined
          • +
        • (res: string): void | Handler<string> | null | undefined

        • Parameters

          • -
            result: string
            +
            res: string

          Returns void + | + Handler<string> | null | @@ -263,12 +299,12 @@

          pause

        • -

          Pause the channel, all notifications are discarded.

          +

          Pause the channel, all notifications are discarded.

          Returns PgChannel

          @@ -286,12 +322,12 @@

          resume

        • -

          Resume the channel.

          +

          Resume the channel.

          Returns PgChannel

          @@ -309,12 +345,12 @@

          subscribeHandler

        • -

          Set an handler called when the the channel get subscribed.

          +

          Set an handler called when the the channel get subscribed.

          Parameters

          @@ -327,17 +363,20 @@
          handler: function
            • -
            • (result: void): void
              • +
            • (res: void): void | Handler<void>

            • Parameters

              • -
                result: void
                +
                res: void
              -

              Returns void

              +

              Returns void + | + Handler<void> +

            • @@ -378,6 +417,9 @@

            Returns exceptionHandler +
          • + fetch +
          • handler
            • @@ -421,13 +463,13 @@

            Returns PgPreparedQuery -
          • +
          • PgResult
          • PgRowSet
            • -
          • +
          • PgStream
          • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgclient.html b/docs/@reactiverse/reactive-pg-client/classes/pgclient.html index 247570083..50ea8a3e2 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgclient.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgclient.html @@ -69,6 +69,17 @@

            Hierarchy

    • @@ -101,12 +112,12 @@

    preparedBatch

  • -

    Prepare and execute a createBatch.

    +

    Prepare and execute a createBatch.

    Parameters

    @@ -131,17 +142,20 @@
    handler: function
    • @@ -86,9 +91,11 @@

    Methods

  • isSSL
  • notificationHandler
  • prepare
    • -
  • preparedBatch
    • -
  • preparedQuery
    • -
  • query
    • +
  • preparedBatch
    • +
  • preparedQuery
    • +
  • query
    • +
  • connect
    • +
  • pool
    • @@ -106,12 +113,12 @@

    begin

  • -

    Begin a transaction and returns a PgTransaction for controlling and tracking +

    Begin a transaction and returns a PgTransaction for controlling and tracking this transaction.

    When the connection is explicitely closed, any inflight transaction is rollbacked.

    @@ -132,12 +139,12 @@

    close

  • -

    Close the current connection after all the pending commands have been processed.

    +

    Close the current connection after all the pending commands have been processed.

    Returns void

    @@ -154,12 +161,12 @@

    closeHandler

  • -

    Set an handler called when the connection is closed.

    +

    Set an handler called when the connection is closed.

    Parameters

    @@ -172,17 +179,20 @@
    handler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -204,12 +214,12 @@

      exceptionHandler

    • -

      Set an handler called with connection errors.

      +

      Set an handler called with connection errors.

      Parameters

      @@ -222,17 +232,20 @@
      handler: function
        • -
        • (result: Error): void
          • +
        • (res: Error): void | Handler<Error>

        • Parameters

          • -
            result: Error
            +
            res: Error
          -

          Returns void

          +

          Returns void + | + Handler<Error> +

        • @@ -254,7 +267,7 @@

        isSSL

      • @@ -274,12 +287,12 @@

        notificationHandler

      • -

        Set an handler called when the connection receives notification on a channel. +

        Set an handler called when the connection receives notification on a channel.

        The handler is called with the PgNotification and has access to the channel name and the notification payload.

        @@ -295,17 +308,20 @@
        handler: function
          • @@ -327,12 +343,12 @@

          prepare

        • -

          Create a prepared query.

          +

          Create a prepared query.

          Parameters

          @@ -351,17 +367,20 @@
          handler: function
            • @@ -372,17 +391,18 @@

            Returns +

            preparedBatch

            -
              +

              • Parameters

                @@ -398,17 +418,20 @@
                handler: function

                  • Parameters

                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<PgRowSet>> +

                  • @@ -419,18 +442,19 @@

                  Returns +

                  preparedQuery

                  -
                    +

                    • Parameters

                      @@ -443,17 +467,20 @@
                      handler: function

                        • Parameters

                          -

                          Returns void

                          +

                          Returns void + | + Handler<AsyncResult<PgRowSet>> +

                        • @@ -464,8 +491,9 @@

                        Returns

                        Parameters

                        @@ -481,17 +509,20 @@
                        handler: function

                          • Parameters

                            -

                            Returns void

                            +

                            Returns void + | + Handler<AsyncResult<PgRowSet>> +

                          • @@ -502,17 +533,18 @@

                          Returns +

                          query

                          -
                            +

                            • Parameters

                              @@ -525,17 +557,20 @@
                              handler: function

                                • Parameters

                                  -

                                  Returns void

                                  +

                                  Returns void + | + Handler<AsyncResult<PgRowSet>> +

                                • @@ -546,6 +581,305 @@

                                Returns + +

                                Static connect

                                +
                                  +
                                • connect(vertx: Vertx, options: PgConnectOptions, handler: function): void
                                  • +
                                • connect(vertx: Vertx, handler: function): void
                                  • +
                                • connect(vertx: Vertx, connectionUri: string, handler: function): void
                                  • +
                                +
                                  +
                                • + +
                                  +
                                  +

                                  Connects to the database and returns the connection if that succeeds. +

                                  + The connection interracts directly with the database is not a proxy, so closing the + connection will close the underlying connection to the database.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                    +
                                  • +
                                    vertx: Vertx
                                    +
                                    +

                                    the vertx instance

                                    +
                                    +
                                    • +
                                  • +
                                    options: PgConnectOptions
                                    +
                                    +

                                    the connect options

                                    +
                                    +
                                    • +
                                  • +
                                    handler: function
                                    +
                                    +

                                    the handler called with the connection or the failure

                                    +
                                    + +
                                    • +
                                  +

                                  Returns void

                                  +
                                  • +
                                • + +
                                  +
                                  +

                                  Like {@link #connect(Vertx, PgConnectOptions, Handler)} with options build from the environment variables.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                    +
                                  • +
                                    vertx: Vertx
                                    +
                                    • +
                                  • +
                                    handler: function
                                    + +
                                    • +
                                  +

                                  Returns void

                                  +
                                  • +
                                • + +
                                  +
                                  +

                                  Like {@link #connect(Vertx, PgConnectOptions, Handler)} with options build from {@code connectionUri}.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                    +
                                  • +
                                    vertx: Vertx
                                    +
                                    • +
                                  • +
                                    connectionUri: string
                                    +
                                    • +
                                  • +
                                    handler: function
                                    + +
                                    • +
                                  +

                                  Returns void

                                  +
                                  • +
                                +
                          +
                          + +

                          Static pool

                          + +
                            +
                          • + +
                            +
                            +

                            Like {@link #pool(PgPoolOptions)} with options build from the environment variables.

                            +
                            +
                            +

                            Returns PgPool

                            +
                            • +
                          • + +
                            +
                            +

                            Like {@link #pool(PgPoolOptions)} with options build from {@code connectionUri}.

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • +
                              connectionUri: string
                              +
                              • +
                            +

                            Returns PgPool

                            +
                            • +
                          • + +
                            +
                            +

                            Like {@link #pool(Vertx, PgPoolOptions)} with options build from the environment variables.

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • +
                              vertx: Vertx
                              +
                              • +
                            +

                            Returns PgPool

                            +
                            • +
                          • + +
                            +
                            +

                            Like {@link #pool(Vertx, PgPoolOptions)} with options build from {@code connectionUri}.

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • +
                              vertx: Vertx
                              +
                              • +
                            • +
                              connectionUri: string
                              +
                              • +
                            +

                            Returns PgPool

                            +
                            • +
                          • + +
                            +
                            +

                            Create a connection pool to the database configured with the given {@code options}.

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • +
                              options: PgPoolOptions
                              +
                              +

                              the options for creating the pool

                              +
                              +
                              • +
                            +

                            Returns PgPool

                            +

                            the connection pool

                            +
                            • +
                          • + +
                            +
                            +

                            Like {@link #pool(PgPoolOptions)} with a specific {@link Vertx} instance.

                            +
                            +
                            +

                            Parameters

                            + +

                            Returns PgPool

                            +
                            • +
                          +

        @@ -599,15 +933,21 @@

        Returns prepare

        • -
      • +
      • preparedBatch
        • -
      • +
      • preparedQuery
        • -
      • +
      • query
        • +
      • + connect +
        • +
      • + pool +
    @@ -630,13 +970,13 @@

    Returns PgPreparedQuery

    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgconnectoptions.html b/docs/@reactiverse/reactive-pg-client/classes/pgconnectoptions.html index cd0136bc8..0aba35ce7 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgconnectoptions.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgconnectoptions.html @@ -77,487 +77,1945 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    - -

    cachePreparedStatements

    -
    cachePreparedStatements: boolean
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    -
    - -

    database

    -
    database: string
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getCachePreparedStatements

    +
      +
    • getCachePreparedStatements(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    host

    -
    host: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    hostnameVerificationAlgorithm

    -
    hostnameVerificationAlgorithm: string
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getDatabase

    +
      +
    • getDatabase(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getHostnameVerificationAlgorithm

    +
      +
    • getHostnameVerificationAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    password

    -
    password: string
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    pipeliningLimit

    -
    pipeliningLimit: number
    - +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    -
    - -

    port

    -
    port: number
    - +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    -
    - -

    reconnectAttempts

    -
    reconnectAttempts: number
    - +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    -
    - -

    reconnectInterval

    -
    reconnectInterval: number
    - +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    getPipeliningLimit

    +
      +
    • getPipeliningLimit(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +

      Returns ProxyOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    getReconnectAttempts

    +
      +
    • getReconnectAttempts(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    getReconnectInterval

    +
      +
    • getReconnectInterval(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    getUser

    +
      +
    • getUser(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    user

    -
    user: string
    - +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsingDomainSocket

    +
      +
    • isUsingDomainSocket(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setCachePreparedStatements

    +
      +
    • setCachePreparedStatements(cachePreparedStatements: boolean): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        cachePreparedStatements: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setDatabase

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        database: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setHostnameVerificationAlgorithm

    +
      +
    • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        hostnameVerificationAlgorithm: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setLocalAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setMetricsName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        password: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    +
      +
    • setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): PgConnectOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPipeliningLimit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pipeliningLimit: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        port: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setProxyOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setReconnectAttempts

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectAttempts: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setReconnectInterval

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectInterval: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTrustAll

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    +
    +
    + +

    setUser

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        user: string
        +
        • +
      +

      Returns PgConnectOptions

      +
      • +
    @@ -588,134 +2046,278 @@

    user

  • PgConnectOptions
    • @@ -742,13 +2344,13 @@

    user

  • PgPreparedQuery
    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgcursor.html b/docs/@reactiverse/reactive-pg-client/classes/pgcursor.html index e4dd672ac..e5261b868 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgcursor.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgcursor.html @@ -100,12 +100,12 @@

    close

  • -

    Release the cursor. +

    Release the cursor.

    It should be called for prepared queries executed with a fetch size.

    @@ -115,12 +115,12 @@

    Returns void
    -

    Like {@link #close()} but with a {@code completionHandler} called when the cursor has been released.

    +

    Like {@link #close()} but with a {@code completionHandler} called when the cursor has been released.

    Parameters

    @@ -130,17 +130,20 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -161,12 +164,12 @@

      hasMore

    • -

      Returns {@code true} when the cursor has results in progress and the {@link #execute} should be called to retrieve +

      Returns {@code true} when the cursor has results in progress and the {@link #execute} should be called to retrieve them.

      @@ -185,12 +188,12 @@

      read

    • -

      Read rows from the cursor, the result is provided asynchronously to the {@code handler}.

      +

      Read rows from the cursor, the result is provided asynchronously to the {@code handler}.

      Parameters

      @@ -209,17 +212,20 @@
      handler: function

        • Parameters

          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<PgRowSet>> +

        • @@ -293,13 +299,13 @@

        Returns void PgPreparedQuery -
      • +
      • PgResult
      • PgRowSet
        • -
      • +
      • PgStream
      • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgiterator.html b/docs/@reactiverse/reactive-pg-client/classes/pgiterator.html index 29dd856ce..0fc6c815c 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgiterator.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgiterator.html @@ -98,7 +98,7 @@

        hasNext

      • Returns boolean

        @@ -115,7 +115,7 @@

        next

      • Returns Row

        @@ -182,13 +182,13 @@

        Returns PgPreparedQuery

        • -
      • +
      • PgResult
      • PgRowSet
        • -
      • +
      • PgStream
      • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgnotification.html b/docs/@reactiverse/reactive-pg-client/classes/pgnotification.html index 036cddfbf..47503d433 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgnotification.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgnotification.html @@ -77,77 +77,217 @@

        Index

        -

        Properties

        +

        Constructors

        +
        +
        +

        Methods

        +

    • -

    Properties

    -
    - -

    channel

    -
    channel: string
    - -
    -
    -

    Set the channel value.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    payload

    -
    payload: string
    - -
    -
    -

    Set the payload value.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getChannel

    +
      +
    • getChannel(): string
      • +
    +
      +
    • + +
      +
      +

      Set the channel value.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    processId

    -
    processId: number
    - -
    -
    -

    Set the process id.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPayload

    +
      +
    • getPayload(): string
      • +
    +
      +
    • + +
      +
      +

      Set the payload value.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getProcessId

    +
      +
    • getProcessId(): number
      • +
    +
      +
    • + +
      +
      +

      Set the process id.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setChannel

    + +
      +
    • + +
      +
      +

      Set the channel value.

      +
      +
      +

      Parameters

      +
        +
      • +
        channel: string
        +
        • +
      +

      Returns PgNotification

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPayload

    + +
      +
    • + +
      +
      +

      Set the payload value.

      +
      +
      +

      Parameters

      +
        +
      • +
        payload: string
        +
        • +
      +

      Returns PgNotification

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setProcessId

    + +
      +
    • + +
      +
      +

      Set the process id.

      +
      +
      +

      Parameters

      +
        +
      • +
        processId: number
        +
        • +
      +

      Returns PgNotification

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -190,14 +330,26 @@

    processId

  • PgNotification
    • @@ -212,13 +364,13 @@

    processId

  • PgPreparedQuery
    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgpool.html b/docs/@reactiverse/reactive-pg-client/classes/pgpool.html index 1d0c69aaa..2f89a3efa 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgpool.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgpool.html @@ -68,7 +68,12 @@

    Class PgPool

    Hierarchy

    • @@ -82,9 +87,11 @@

    Methods

  • begin
  • close
  • getConnection
    • -
  • preparedBatch
    • -
  • preparedQuery
    • -
  • query
    • +
  • preparedBatch
    • +
  • preparedQuery
    • +
  • query
    • +
  • connect
    • +
  • pool
    • @@ -102,12 +109,12 @@

    begin

  • -

    Borrow a connection from the pool and begin a transaction, the underlying connection will be returned +

    Borrow a connection from the pool and begin a transaction, the underlying connection will be returned to the pool when the transaction ends.

    @@ -118,17 +125,20 @@
    handler: function
      • @@ -150,12 +160,12 @@

      close

    • -

      Close the pool and release the associated resources.

      +

      Close the pool and release the associated resources.

      Returns void

      @@ -172,12 +182,12 @@

      getConnection

    • -

      Get a connection from the pool.

      +

      Get a connection from the pool.

      Parameters

      @@ -190,17 +200,20 @@
      handler: function
    • -
    +

    preparedBatch

    -
      +
      • preparedBatch(sql: string, batch: Tuple[], handler: function): PgPool

      • Parameters

        @@ -237,17 +251,20 @@
        handler: function

          • Parameters

            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<PgRowSet>> +

          • @@ -258,18 +275,19 @@

          Returns +

          preparedQuery

          -
          -

          Properties

          -
          - -

          cachePreparedStatements

          -
          cachePreparedStatements: boolean
          - +

          Constructors

          +
          + +

          constructor

          + +
          -
          - -

          connectTimeout

          -
          connectTimeout: number
          - +
          +
          +

          Methods

          +
          + +

          addCrlPath

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              crlPaths: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          crlPaths

          -
          crlPaths: string
          - +
          + +

          addCrlValue

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              crlValues: Buffer
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          crlValues

          -
          crlValues: Buffer
          - +
          + +

          addEnabledCipherSuite

          +
            +
          • addEnabledCipherSuite(enabledCipherSuites: string): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              enabledCipherSuites: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          database

          -
          database: string
          - +
          + +

          addEnabledSecureTransportProtocol

          +
            +
          • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              enabledSecureTransportProtocols: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          enabledCipherSuites

          -
          enabledCipherSuites: string
          - +
          + +

          getCachePreparedStatements

          +
            +
          • getCachePreparedStatements(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          -
          - -

          enabledSecureTransportProtocols

          -
          enabledSecureTransportProtocols: string
          - +
          + +

          getConnectTimeout

          +
            +
          • getConnectTimeout(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          -
          - -

          host

          -
          host: string
          - +
          + +

          getCrlPaths

          +
            +
          • getCrlPaths(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          -
          - -

          hostnameVerificationAlgorithm

          -
          hostnameVerificationAlgorithm: string
          - +
          + +

          getCrlValues

          +
            +
          • getCrlValues(): Buffer
            • +
          +
            +
          • + +

            Returns Buffer

            +
            • +
          -
          - -

          idleTimeout

          -
          idleTimeout: number
          - +
          + +

          getDatabase

          +
            +
          • getDatabase(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          -
          - -

          jdkSslEngineOptions

          -
          jdkSslEngineOptions: JdkSSLEngineOptions
          - +
          + +

          getEnabledCipherSuites

          +
            +
          • getEnabledCipherSuites(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          -
          - -

          keyStoreOptions

          -
          keyStoreOptions: JksOptions
          - +
          + +

          getEnabledSecureTransportProtocols

          +
            +
          • getEnabledSecureTransportProtocols(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          getHost

          +
            +
          • getHost(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          getHostnameVerificationAlgorithm

          +
            +
          • getHostnameVerificationAlgorithm(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          getIdleTimeout

          +
            +
          • getIdleTimeout(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getIdleTimeoutUnit

          +
            +
          • getIdleTimeoutUnit(): any
            • +
          +
            +
          • + +

            Returns any

            +
            • +
          +
          +
          + +

          getJdkSslEngineOptions

          +
            +
          • getJdkSslEngineOptions(): JdkSSLEngineOptions
            • +
          +
            +
          • + +

            Returns JdkSSLEngineOptions

            +
            • +
          +
          +
          + +

          getKeyStoreOptions

          +
            +
          • getKeyStoreOptions(): JksOptions
            • +
          +
            +
          • + +

            Returns JksOptions

            +
            • +
          +
          +
          + +

          getLocalAddress

          +
            +
          • getLocalAddress(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          getLogActivity

          +
            +
          • getLogActivity(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          getMaxSize

          +
            +
          • getMaxSize(): number
            • +
          +
            +
          • + +
            +
            +

            Set the maximum pool size

            +
            +
            +

            Returns number

            +

            a reference to this, so the API can be used fluently

            +
            • +
          +
          +
          + +

          getMaxWaitQueueSize

          +
            +
          • getMaxWaitQueueSize(): number
            • +
          +
            +
          • + +
            +
            +

            Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in + an failure. If the value is set to a negative number then the queue will be unbounded.

            +
            +
            +

            Returns number

            +

            a reference to this, so the API can be used fluently

            +
            • +
          +
          +
          + +

          getMetricsName

          +
            +
          • getMetricsName(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          getOpenSslEngineOptions

          +
            +
          • getOpenSslEngineOptions(): OpenSSLEngineOptions
            • +
          +
            +
          • + +

            Returns OpenSSLEngineOptions

            +
            • +
          +
          +
          + +

          getPassword

          +
            +
          • getPassword(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          getPemKeyCertOptions

          +
            +
          • getPemKeyCertOptions(): PemKeyCertOptions
            • +
          +
            +
          • + +

            Returns PemKeyCertOptions

            +
            • +
          +
          +
          + +

          getPemTrustOptions

          +
            +
          • getPemTrustOptions(): PemTrustOptions
            • +
          +
            +
          • + +

            Returns PemTrustOptions

            +
            • +
          +
          +
          + +

          getPfxKeyCertOptions

          +
            +
          • getPfxKeyCertOptions(): PfxOptions
            • +
          +
            +
          • + +

            Returns PfxOptions

            +
            • +
          +
          +
          + +

          getPfxTrustOptions

          +
            +
          • getPfxTrustOptions(): PfxOptions
            • +
          +
            +
          • + +

            Returns PfxOptions

            +
            • +
          +
          +
          + +

          getPipeliningLimit

          +
            +
          • getPipeliningLimit(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getPort

          +
            +
          • getPort(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getProxyOptions

          +
            +
          • getProxyOptions(): ProxyOptions
            • +
          +
            +
          • + +

            Returns ProxyOptions

            +
            • +
          +
          +
          + +

          getReceiveBufferSize

          +
            +
          • getReceiveBufferSize(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getReconnectAttempts

          +
            +
          • getReconnectAttempts(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getReconnectInterval

          +
            +
          • getReconnectInterval(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getSendBufferSize

          +
            +
          • getSendBufferSize(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getSoLinger

          +
            +
          • getSoLinger(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getTrafficClass

          +
            +
          • getTrafficClass(): number
            • +
          +
            +
          • + +

            Returns number

            +
            • +
          +
          +
          + +

          getTrustStoreOptions

          +
            +
          • getTrustStoreOptions(): JksOptions
            • +
          +
            +
          • + +

            Returns JksOptions

            +
            • +
          +
          +
          + +

          getUser

          +
            +
          • getUser(): string
            • +
          +
            +
          • + +

            Returns string

            +
            • +
          +
          +
          + +

          isReuseAddress

          +
            +
          • isReuseAddress(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isReusePort

          +
            +
          • isReusePort(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isSsl

          +
            +
          • isSsl(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isTcpCork

          +
            +
          • isTcpCork(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isTcpFastOpen

          +
            +
          • isTcpFastOpen(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isTcpKeepAlive

          +
            +
          • isTcpKeepAlive(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isTcpNoDelay

          +
            +
          • isTcpNoDelay(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isTcpQuickAck

          +
            +
          • isTcpQuickAck(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isTrustAll

          +
            +
          • isTrustAll(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isUseAlpn

          +
            +
          • isUseAlpn(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isUsePooledBuffers

          +
            +
          • isUsePooledBuffers(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          isUsingDomainSocket

          +
            +
          • isUsingDomainSocket(): boolean
            • +
          +
            +
          • + +

            Returns boolean

            +
            • +
          +
          +
          + +

          setCachePreparedStatements

          +
            +
          • setCachePreparedStatements(cachePreparedStatements: boolean): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              cachePreparedStatements: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setConnectTimeout

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              connectTimeout: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setDatabase

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              database: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setEnabledSecureTransportProtocols

          +
            +
          • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              enabledSecureTransportProtocols: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setHost

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              host: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setHostnameVerificationAlgorithm

          +
            +
          • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              hostnameVerificationAlgorithm: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setIdleTimeout

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              idleTimeout: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setIdleTimeoutUnit

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              idleTimeoutUnit: any
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setJdkSslEngineOptions

          +
            +
          • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              jdkSslEngineOptions: JdkSSLEngineOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          +
          +
          + +

          setKeyStoreOptions

          +
            +
          • setKeyStoreOptions(keyStoreOptions: JksOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              keyStoreOptions: JksOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          localAddress

          -
          localAddress: string
          - +
          + +

          setLocalAddress

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              localAddress: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          logActivity

          -
          logActivity: boolean
          - +
          + +

          setLogActivity

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              logActivity: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          maxSize

          -
          maxSize: number
          - -
          -
          -

          Set the maximum pool size

          -
          -
          -
          param
          -

          the maximum pool size

          -
          -
          returns
          -

          a reference to this, so the API can be used fluently

          -
          -
          -
          +
          + +

          setMaxSize

          + +
            +
          • + +
            +
            +

            Set the maximum pool size

            +
            +
            +

            Parameters

            +
              +
            • +
              maxSize: number
              +
              +

              the maximum pool size

              +
              +
              • +
            +

            Returns PgPoolOptions

            +

            a reference to this, so the API can be used fluently

            +
            • +
          -
          - -

          maxWaitQueueSize

          -
          maxWaitQueueSize: number
          - -
          -
          -

          Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in - an failure. If the value is set to a negative number then the queue will be unbounded.

          -
          -
          -
          param
          -

          the maximum number of waiting requests

          -
          -
          returns
          -

          a reference to this, so the API can be used fluently

          -
          -
          -
          +
          + +

          setMaxWaitQueueSize

          +
            +
          • setMaxWaitQueueSize(maxWaitQueueSize: number): PgPoolOptions
            • +
          +
            +
          • + +
            +
            +

            Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in + an failure. If the value is set to a negative number then the queue will be unbounded.

            +
            +
            +

            Parameters

            +
              +
            • +
              maxWaitQueueSize: number
              +
              +

              the maximum number of waiting requests

              +
              +
              • +
            +

            Returns PgPoolOptions

            +

            a reference to this, so the API can be used fluently

            +
            • +
          -
          - -

          metricsName

          -
          metricsName: string
          - +
          + +

          setMetricsName

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              metricsName: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          openSslEngineOptions

          -
          openSslEngineOptions: OpenSSLEngineOptions
          - +
          + +

          setOpenSslEngineOptions

          +
            +
          • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              openSslEngineOptions: OpenSSLEngineOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          password

          -
          password: string
          - +
          + +

          setPassword

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              password: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          pemKeyCertOptions

          -
          pemKeyCertOptions: PemKeyCertOptions
          - +
          + +

          setPemKeyCertOptions

          +
            +
          • setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              pemKeyCertOptions: PemKeyCertOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          pemTrustOptions

          -
          pemTrustOptions: PemTrustOptions
          - +
          + +

          setPemTrustOptions

          +
            +
          • setPemTrustOptions(pemTrustOptions: PemTrustOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              pemTrustOptions: PemTrustOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          pfxKeyCertOptions

          -
          pfxKeyCertOptions: PfxOptions
          - +
          + +

          setPfxKeyCertOptions

          +
            +
          • setPfxKeyCertOptions(pfxKeyCertOptions: PfxOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              pfxKeyCertOptions: PfxOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          pfxTrustOptions

          -
          pfxTrustOptions: PfxOptions
          - +
          + +

          setPfxTrustOptions

          +
            +
          • setPfxTrustOptions(pfxTrustOptions: PfxOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              pfxTrustOptions: PfxOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          pipeliningLimit

          -
          pipeliningLimit: number
          - +
          + +

          setPipeliningLimit

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              pipeliningLimit: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          port

          -
          port: number
          - +
          + +

          setPort

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              port: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          proxyOptions

          -
          proxyOptions: ProxyOptions
          - +
          + +

          setProxyOptions

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              proxyOptions: ProxyOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          receiveBufferSize

          -
          receiveBufferSize: number
          - +
          + +

          setReceiveBufferSize

          +
            +
          • setReceiveBufferSize(receiveBufferSize: number): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              receiveBufferSize: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          reconnectAttempts

          -
          reconnectAttempts: number
          - +
          + +

          setReconnectAttempts

          +
            +
          • setReconnectAttempts(reconnectAttempts: number): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              reconnectAttempts: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          reconnectInterval

          -
          reconnectInterval: number
          - +
          + +

          setReconnectInterval

          +
            +
          • setReconnectInterval(reconnectInterval: number): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              reconnectInterval: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          reuseAddress

          -
          reuseAddress: boolean
          - +
          + +

          setReuseAddress

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              reuseAddress: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          reusePort

          -
          reusePort: boolean
          - +
          + +

          setReusePort

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              reusePort: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          sendBufferSize

          -
          sendBufferSize: number
          - +
          + +

          setSendBufferSize

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              sendBufferSize: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          soLinger

          -
          soLinger: number
          - +
          + +

          setSoLinger

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              soLinger: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          ssl

          -
          ssl: boolean
          - +
          + +

          setSsl

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              ssl: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          tcpCork

          -
          tcpCork: boolean
          - +
          + +

          setTcpCork

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              tcpCork: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          tcpFastOpen

          -
          tcpFastOpen: boolean
          - +
          + +

          setTcpFastOpen

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              tcpFastOpen: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          tcpKeepAlive

          -
          tcpKeepAlive: boolean
          - +
          + +

          setTcpKeepAlive

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              tcpKeepAlive: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          tcpNoDelay

          -
          tcpNoDelay: boolean
          - +
          + +

          setTcpNoDelay

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              tcpNoDelay: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          tcpQuickAck

          -
          tcpQuickAck: boolean
          - +
          + +

          setTcpQuickAck

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              tcpQuickAck: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          trafficClass

          -
          trafficClass: number
          - +
          + +

          setTrafficClass

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              trafficClass: number
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          trustAll

          -
          trustAll: boolean
          - +
          + +

          setTrustAll

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              trustAll: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          trustStoreOptions

          -
          trustStoreOptions: JksOptions
          - +
          + +

          setTrustStoreOptions

          +
            +
          • setTrustStoreOptions(trustStoreOptions: JksOptions): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              trustStoreOptions: JksOptions
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          useAlpn

          -
          useAlpn: boolean
          - +
          + +

          setUseAlpn

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              useAlpn: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          usePooledBuffers

          -
          usePooledBuffers: boolean
          - +
          + +

          setUsePooledBuffers

          +
            +
          • setUsePooledBuffers(usePooledBuffers: boolean): PgPoolOptions
            • +
          +
            +
          • + +

            Parameters

            +
              +
            • +
              usePooledBuffers: boolean
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          -
          - -

          user

          -
          user: string
          - +
          + +

          setUser

          + +
            +
          • + +

            Parameters

            +
              +
            • +
              user: string
              +
              • +
            +

            Returns PgPoolOptions

            +
            • +
          @@ -655,140 +2180,290 @@

          user

        • PgPoolOptions
          • @@ -797,13 +2472,13 @@

          user

        • PgPreparedQuery
          • -
        • +
        • PgResult
        • PgRowSet
          • -
        • +
        • PgStream
        • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgpreparedquery.html b/docs/@reactiverse/reactive-pg-client/classes/pgpreparedquery.html index b6ea68c31..0b622132a 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgpreparedquery.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgpreparedquery.html @@ -101,12 +101,12 @@

          batch

        • -

          Execute a batch.

          +

          Execute a batch.

          Parameters

          @@ -122,17 +122,20 @@
          handler: function

            • Parameters

              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<PgRowSet>> +

            • @@ -155,12 +158,12 @@

            close

          • -

            Close the prepared query and release its resources.

            +

            Close the prepared query and release its resources.

            Returns void

            @@ -168,12 +171,12 @@

            Returns void
            -

            Like {@link #close()} but notifies the {@code completionHandler} when it's closed.

            +

            Like {@link #close()} but notifies the {@code completionHandler} when it's closed.

            Parameters

            @@ -183,17 +186,20 @@
            completionHandler: function
              • -
              • (result: AsyncResult<void>): void
                • +
              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

              • Parameters

                • -
                  result: AsyncResult<void>
                  +
                  res: AsyncResult<void>
                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<void>> +

              • @@ -208,18 +214,18 @@

              Returns void

              createStream

              • -

                Execute the prepared query with a cursor and createStream the result. The createStream opens a cursor +

                Execute the prepared query with a cursor and createStream the result. The createStream opens a cursor with a {@code fetch} size to fetch the results.

                Note: this requires to be in a transaction, since cursors require it.

                @@ -240,7 +246,7 @@
                args: Tuple
              -

              Returns PgStream

              +

              Returns PgStream<Row>

              the createStream

            @@ -256,7 +262,7 @@

            cursor

          • @@ -267,12 +273,12 @@

            Returns
            -

            Create a cursor with the provided {@code arguments}.

            +

            Create a cursor with the provided {@code arguments}.

            Parameters

            @@ -300,12 +306,12 @@

            execute

          • -

            Calls {@link #execute(Tuple, Handler)} with an empty tuple argument.

            +

            Calls {@link #execute(Tuple, Handler)} with an empty tuple argument.

            Parameters

            @@ -315,17 +321,20 @@
            handler: function

            • +
            +

            Type parameters

            +
              +
            • +

              T

              +
              • +
            +

            Hierarchy

            @@ -101,12 +114,12 @@

            columnsNames

          • -

            Get the names of columns in the PgResult.

            +

            Get the names of columns in the PgResult.

            Returns string[]

            @@ -118,22 +131,22 @@

            Returns string

            next

            • -

              Return the next available result or {@code null}, e.g for a simple query that executed multiple queries or for +

              Return the next available result or {@code null}, e.g for a simple query that executed multiple queries or for a batch result.

              -

              Returns PgResult

              +

              Returns PgResult<T>

              the next available result or {@code null} if none is available

            @@ -148,12 +161,12 @@

            rowCount

          • -

            Get the number of the affected rows in the operation to this PgResult. +

            Get the number of the affected rows in the operation to this PgResult.

            The meaning depends on the executed statement:

              @@ -179,12 +192,12 @@

              size

            • -

              Get the number of rows in the PgResult.

              +

              Get the number of rows in the PgResult.

              Returns number

              @@ -196,21 +209,21 @@

              Returns number

              value

                -
              • value(): Object
                • +
              • value(): T
              • -

                Get the result value.

                +

                Get the result value.

                -

                Returns Object

                +

                Returns T

                the result

              @@ -265,7 +278,7 @@

              Returns Object

              -
            • +
            • PgResult
              • @@ -290,7 +303,7 @@

                Returns Object PgRowSet

                • -
              • +
              • PgStream
              • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgrowset.html b/docs/@reactiverse/reactive-pg-client/classes/pgrowset.html index 3a350e991..89c616308 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgrowset.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgrowset.html @@ -68,7 +68,12 @@

                Class PgRowSet

                Hierarchy

          • @@ -79,9 +84,12 @@

          Index

          Methods

          @@ -89,6 +97,30 @@

          Methods

          Methods

          +
          + +

          columnsNames

          +
            +
          • columnsNames(): string[]
            • +
          +
            +
          • + +
            +
            +

            Get the names of columns in the PgResult.

            +
            +
            +

            Returns string[]

            +

            the list of names of columns.

            +
            • +
          +

          iterator

          @@ -99,46 +131,104 @@

          iterator

        • Returns PgIterator

    -
    +

    next

    -
    -
    +
    + +

    rowCount

    +
      +
    • rowCount(): number
      • +
    +
      +
    • + +
      +
      +

      Get the number of the affected rows in the operation to this PgResult. +

      + The meaning depends on the executed statement: +

        +
      • INSERT: the number of rows inserted
        • +
      • DELETE: the number of rows deleted
        • +
      • UPDATE: the number of rows updated
        • +
      • SELECT: the number of rows retrieved
        • +

      +
      +
      +

      Returns number

      +

      the count of affected rows.

      +
      • +
    +
    +
    + +

    size

    +
      +
    • size(): number
      • +
    +
      +
    • + +
      +
      +

      Get the number of rows in the PgResult.

      +
      +
      +

      Returns number

      +

      the count of rows.

      +
      • +
    +
    +

    value

    -
      -
    • +
    • PgStream
    • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgstream.html b/docs/@reactiverse/reactive-pg-client/classes/pgstream.html index 4f678abef..e03b525fb 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgstream.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgstream.html @@ -57,13 +57,21 @@ PgStream
    -

    Class PgStream

    +

    Class PgStream<T>

    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Hierarchy

      @@ -72,6 +80,12 @@

      Hierarchy

    +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -82,6 +96,7 @@

    Methods

  • close
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • handler
  • pause
  • resume
    • @@ -103,12 +118,12 @@

    close

  • -

    Close the stream and release the resources.

    +

    Close the stream and release the resources.

    Returns void

    @@ -116,12 +131,12 @@

    Returns void
    -

    Close the stream and release the resources.

    +

    Close the stream and release the resources.

    Parameters

    @@ -134,17 +149,20 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -159,13 +177,13 @@

      Returns void

      endHandler

        -
      • endHandler(endHandler: function): PgStream
        • +
      • endHandler(endHandler: function): PgStream<T>

      • Parameters

        @@ -175,17 +193,19 @@
        endHandler: function
          • -
          • (result: void): void | null | undefined
            • +
          • (res: void): void | Handler<void> | null | undefined

          • Parameters

            • -
              result: void
              +
              res: void

            Returns void + | + Handler<void> | null | @@ -197,7 +217,7 @@

            Returns void

          -

          Returns PgStream

          +

          Returns PgStream<T>

    • @@ -205,13 +225,13 @@

    Returns

    exceptionHandler

      -
    • exceptionHandler(handler: function): PgStream
      • +
    • exceptionHandler(handler: function): PgStream<T>

    • Parameters

      @@ -221,17 +241,19 @@
      handler: function
        • -
        • (result: Error): void | null | undefined
          • +
        • (res: Error): void | Handler<Error> | null | undefined

        • Parameters

          • -
            result: Error
            +
            res: Error

          Returns void + | + Handler<Error> | null | @@ -243,7 +265,30 @@

          Returns void

        -

        Returns PgStream

        +

        Returns PgStream<T>

        +
        • +
      +
    +
    + +

    fetch

    +
      +
    • fetch(arg0: number): ReadStream<T>
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        arg0: number
        +
        • +
      +

      Returns ReadStream<T>

    @@ -251,13 +296,13 @@

    Returns

    handler

      -
    • handler(handler: function): PgStream
      • +
    • handler(handler: function): PgStream<T>

    • Parameters

      @@ -267,17 +312,19 @@
      handler: function
        • -
        • (result: any): void | null | undefined
          • +
        • (res: T): void | Handler<T> | null | undefined

        • Parameters

          • -
            result: any
            +
            res: T

          Returns void + | + Handler<T> | null | @@ -289,7 +336,7 @@

          Returns void

        -

        Returns PgStream

        +

        Returns PgStream<T>

    @@ -297,16 +344,16 @@

    Returns

    pause

    • -

      Returns PgStream

      +

      Returns PgStream<T>

    @@ -314,16 +361,16 @@

    Returns

    resume

    • -

      Returns PgStream

      +

      Returns PgStream<T>

    @@ -375,7 +422,7 @@

    Returns PgPreparedQuery -
  • +
  • PgResult
  • @@ -383,7 +430,7 @@

    Returns -
  • +
  • PgStream
    • @@ -395,6 +442,9 @@

      Returns exceptionHandler

      • +
    • + fetch +
    • handler
      • diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgsubscriber.html b/docs/@reactiverse/reactive-pg-client/classes/pgsubscriber.html index ae4347497..4f99f9e53 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgsubscriber.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgsubscriber.html @@ -129,7 +129,7 @@

      channel

      -

      Return a channel for the given {@code name}.

      +

      Return a channel for the given {@code name}.

      Parameters

      @@ -178,7 +178,7 @@

      close

      -

      Close the subscriber, the retry policy will not be invoked.

      +

      Close the subscriber, the retry policy will not be invoked.

      Returns void

      @@ -200,7 +200,7 @@

      closeHandler

      -

      Set an handler called when the subscriber is closed.

      +

      Set an handler called when the subscriber is closed.

      Parameters

      @@ -213,17 +213,20 @@
      handler: function
        • -
        • (result: void): void
          • +
        • (res: void): void | Handler<void>

        • Parameters

          • -
            result: void
            +
            res: void
          -

          Returns void

          +

          Returns void + | + Handler<void> +

        • @@ -270,7 +273,7 @@

        connect

        -

        Connect the subscriber to Postgres.

        +

        Connect the subscriber to Postgres.

        Parameters

        @@ -283,17 +286,20 @@
        handler: function
          • -
          • (result: AsyncResult<void>): void
            • +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

          • Parameters

            • -
              result: AsyncResult<void>
              +
              res: AsyncResult<void>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<void>> +

          • @@ -320,7 +326,7 @@

          reconnectPolicy

          -

          Set the reconnect policy that is executed when the subscriber is disconnected. +

          Set the reconnect policy that is executed when the subscriber is disconnected.

          When the subscriber is disconnected, the {@code policy} function is called with the actual number of retries and returns an {@code amountOfTime} value: @@ -343,14 +349,14 @@

          policy: function
            • -
            • (t: number): number
              • +
            • (arg: number): number

            • Parameters

              • -
                t: number
                +
                arg: number

              Returns number

              @@ -380,7 +386,7 @@

              Static subscriber

              -

              Create a subscriber.

              +

              Create a subscriber.

              Parameters

              @@ -451,13 +457,13 @@

              Returns PgPreparedQuery

              • -
            • +
            • PgResult
            • PgRowSet
              • -
            • +
            • PgStream
            diff --git a/docs/@reactiverse/reactive-pg-client/classes/pgtransaction.html b/docs/@reactiverse/reactive-pg-client/classes/pgtransaction.html index 9a0ad4c6a..036bf348d 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/pgtransaction.html +++ b/docs/@reactiverse/reactive-pg-client/classes/pgtransaction.html @@ -68,7 +68,12 @@

            Class PgTransaction

            Hierarchy

            • - PgTransaction + PgClient +
                +
              • + PgTransaction +
                • +

    • @@ -81,10 +86,13 @@

    Methods

    @@ -102,12 +110,12 @@

    abortHandler

  • -

    Set an handler to be called when the transaction is aborted.

    +

    Set an handler to be called when the transaction is aborted.

    Parameters

    @@ -120,17 +128,20 @@
    handler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -152,12 +163,12 @@

      commit

    • -

      Commit the current transaction.

      +

      Commit the current transaction.

      Returns void

      @@ -165,12 +176,12 @@

      Returns void
      -

      Like {@link #commit} with an handler to be notified when the transaction commit has completed

      +

      Like {@link #commit} with an handler to be notified when the transaction commit has completed

      Parameters

      @@ -180,17 +191,20 @@
      handler: function
        • -
        • (result: AsyncResult<void>): void
          • +
        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

        • Parameters

          • -
            result: AsyncResult<void>
            +
            res: AsyncResult<void>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<void>> +

        • @@ -202,16 +216,75 @@

        Returns void

    • + +

    prepare

    + +
      +
    • + +
      +
      +

      Create a prepared query.

      +
      +
      +

      Parameters

      +
        +
      • +
        sql: string
        +
        +

        the sql

        +
        +
        • +
      • +
        handler: function
        +
        +

        the handler notified with the prepared query asynchronously

        +
        + +
        • +
      +

      Returns PgTransaction

      +
      • +
    +
    +

    preparedBatch

    -
      +

      • Parameters

        @@ -227,17 +300,20 @@
        handler: function

          • Parameters

            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<PgRowSet>> +

          • @@ -248,18 +324,19 @@

          Returns +

          preparedQuery

          -
            +

            • Parameters

              @@ -272,17 +349,20 @@
              handler: function

                • Parameters

                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<PgRowSet>> +

                • @@ -293,8 +373,9 @@

                Returns

                Parameters

                @@ -310,17 +391,20 @@
                handler: function

                  • Parameters

                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<PgRowSet>> +

                  • @@ -331,17 +415,18 @@

                  Returns +

                  query

                  -
                    +

                    • Parameters

                      @@ -354,17 +439,20 @@
                      handler: function

                        • Parameters

                          -

                          Returns void

                          +

                          Returns void + | + Handler<AsyncResult<PgRowSet>> +

                        • @@ -386,12 +474,12 @@

                        rollback

                      • -

                        Rollback the current transaction.

                        +

                        Rollback the current transaction.

                        Returns void

                        @@ -399,12 +487,12 @@

                        Returns void
                        -

                        Like {@link #rollback} with an handler to be notified when the transaction rollback has completed

                        +

                        Like {@link #rollback} with an handler to be notified when the transaction rollback has completed

                        Parameters

                        @@ -414,17 +502,20 @@
                        handler: function
                          • -
                          • (result: AsyncResult<void>): void
                            • +
                          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                          • Parameters

                            • -
                              result: AsyncResult<void>
                              +
                              res: AsyncResult<void>
                            -

                            Returns void

                            +

                            Returns void + | + Handler<AsyncResult<void>> +

                          • @@ -435,6 +526,305 @@

                          Returns void

                  +
                  + +

                  Static connect

                  +
                    +
                  • connect(vertx: Vertx, options: PgConnectOptions, handler: function): void
                    • +
                  • connect(vertx: Vertx, handler: function): void
                    • +
                  • connect(vertx: Vertx, connectionUri: string, handler: function): void
                    • +
                  +
                    +
                  • + +
                    +
                    +

                    Connects to the database and returns the connection if that succeeds. +

                    + The connection interracts directly with the database is not a proxy, so closing the + connection will close the underlying connection to the database.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      vertx: Vertx
                      +
                      +

                      the vertx instance

                      +
                      +
                      • +
                    • +
                      options: PgConnectOptions
                      +
                      +

                      the connect options

                      +
                      +
                      • +
                    • +
                      handler: function
                      +
                      +

                      the handler called with the connection or the failure

                      +
                      + +
                      • +
                    +

                    Returns void

                    +
                    • +
                  • + +
                    +
                    +

                    Like {@link #connect(Vertx, PgConnectOptions, Handler)} with options build from the environment variables.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      vertx: Vertx
                      +
                      • +
                    • +
                      handler: function
                      + +
                      • +
                    +

                    Returns void

                    +
                    • +
                  • + +
                    +
                    +

                    Like {@link #connect(Vertx, PgConnectOptions, Handler)} with options build from {@code connectionUri}.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      vertx: Vertx
                      +
                      • +
                    • +
                      connectionUri: string
                      +
                      • +
                    • +
                      handler: function
                      + +
                      • +
                    +

                    Returns void

                    +
                    • +
                  +
                  +
                  + +

                  Static pool

                  + +
                    +
                  • + +
                    +
                    +

                    Like {@link #pool(PgPoolOptions)} with options build from the environment variables.

                    +
                    +
                    +

                    Returns PgPool

                    +
                    • +
                  • + +
                    +
                    +

                    Like {@link #pool(PgPoolOptions)} with options build from {@code connectionUri}.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      connectionUri: string
                      +
                      • +
                    +

                    Returns PgPool

                    +
                    • +
                  • + +
                    +
                    +

                    Like {@link #pool(Vertx, PgPoolOptions)} with options build from the environment variables.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      vertx: Vertx
                      +
                      • +
                    +

                    Returns PgPool

                    +
                    • +
                  • + +
                    +
                    +

                    Like {@link #pool(Vertx, PgPoolOptions)} with options build from {@code connectionUri}.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      vertx: Vertx
                      +
                      • +
                    • +
                      connectionUri: string
                      +
                      • +
                    +

                    Returns PgPool

                    +
                    • +
                  • + +
                    +
                    +

                    Create a connection pool to the database configured with the given {@code options}.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • +
                      options: PgPoolOptions
                      +
                      +

                      the options for creating the pool

                      +
                      +
                      • +
                    +

                    Returns PgPool

                    +

                    the connection pool

                    +
                    • +
                  • + +
                    +
                    +

                    Like {@link #pool(PgPoolOptions)} with a specific {@link Vertx} instance.

                    +
                    +
                    +

                    Parameters

                    + +

                    Returns PgPool

                    +
                    • +
                  +

          @@ -483,13 +873,13 @@

          Returns void PgPreparedQuery -
        • +
        • PgResult
        • PgRowSet
          • -
        • +
        • PgStream
        • @@ -507,17 +897,26 @@

          Returns voidcommit

        • + prepare +
          • +
        • preparedBatch
          • -
        • +
        • preparedQuery
          • -
        • +
        • query
        • rollback
          • +
        • + connect +
          • +
        • + pool +

      diff --git a/docs/@reactiverse/reactive-pg-client/classes/point.html b/docs/@reactiverse/reactive-pg-client/classes/point.html index 406ab5883..e8934afd7 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/point.html +++ b/docs/@reactiverse/reactive-pg-client/classes/point.html @@ -77,36 +77,139 @@

      Index

      -

      Properties

      +

      Constructors

      +
      +
      +

      Methods

      +
    -

    Properties

    -
    - -

    x

    -
    x: number
    - +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Point

      +
      • +
    • + +

      Parameters

      + +

      Returns Point

      +
      • +
    -
    - -

    y

    -
    y: number
    - +
    +
    +

    Methods

    +
    + +

    getX

    +
      +
    • getX(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getY

    +
      +
    • getY(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    setX

    +
      +
    • setX(x: number): Point
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      +

      Returns Point

      +
      • +
    +
    +
    + +

    setY

    +
      +
    • setY(y: number): Point
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        y: number
        +
        • +
      +

      Returns Point

      +
      • +
    @@ -156,13 +259,13 @@

    y

  • PgPreparedQuery
    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • @@ -176,11 +279,20 @@

    y

  • Point
    • diff --git a/docs/@reactiverse/reactive-pg-client/classes/row.html b/docs/@reactiverse/reactive-pg-client/classes/row.html index fb3467dba..3985d7adb 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/row.html +++ b/docs/@reactiverse/reactive-pg-client/classes/row.html @@ -68,7 +68,12 @@

    Class Row

    Hierarchy

    • - Row + Tuple +
        +
      • + Row +
        • +
    @@ -79,17 +84,31 @@

    Index

    Methods

    @@ -97,22 +116,371 @@

    Methods

    Methods

    -
    +
    + +

    addBoolean

    +
      +
    • addBoolean(value: boolean): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a boolean value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: boolean
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addBuffer

    +
      +
    • addBuffer(value: Buffer): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a buffer value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: Buffer
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addDouble

    +
      +
    • addDouble(value: number): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a double value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: number
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addFloat

    +
      +
    • addFloat(value: number): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a float value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: number
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addInteger

    +
      +
    • addInteger(value: number): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add an integer value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: number
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addJson

    + +
      +
    • + +
      +
      +

      Add a json value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: Json
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addLong

    +
      +
    • addLong(value: number): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a long value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: number
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addShort

    +
      +
    • addShort(value: number): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a short value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: number
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addString

    +
      +
    • addString(value: string): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add a string value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: string
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addValue

    +
      +
    • addValue(value: any): Tuple
      • +
    +
      +
    • + +
      +
      +

      Add an object value at the end of the tuple.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: any
        +
        +

        the value

        +
        +
        • +
      +

      Returns Tuple

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    clear

    +
      +
    • clear(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +

    getBoolean

    -
      +
      • getBoolean(name: string): boolean
      • -

        Get a boolean value at {@code pos}.

        +

        Get a boolean value at {@code pos}.

        Parameters

        @@ -129,22 +497,23 @@

        Returns boolean

    -
    +

    getBuffer

    -
      +
      • getBuffer(name: string): Buffer
      • -

        Get a buffer value at {@code pos}.

        +

        Get a buffer value at {@code pos}.

        Parameters

        @@ -171,12 +540,12 @@

        getColumnName

      • -

        Get a column name at {@code pos}.

        +

        Get a column name at {@code pos}.

        Parameters

        @@ -193,22 +562,23 @@

        Returns string

    -
    +

    getDouble

    -
      +
      • getDouble(name: string): number
      • -

        Get a double value at {@code pos}.

        +

        Get a double value at {@code pos}.

        Parameters

        @@ -225,22 +595,23 @@

        Returns number

    -
    +

    getFloat

    -
      +
      • getFloat(name: string): number
      • -

        Get a float value at {@code pos}.

        +

        Get a float value at {@code pos}.

        Parameters

        @@ -257,22 +628,23 @@

        Returns number

    -
    +

    getInteger

    -
      +
      • getInteger(name: string): number
      • -

        Get an integer value at {@code pos}.

        +

        Get an integer value at {@code pos}.

        Parameters

        @@ -289,22 +661,23 @@

        Returns number

    -
    +

    getJson

    -
      +
      • getJson(name: string): Json
      • -

        Get a json value at {@code pos}.

        +

        Get a json value at {@code pos}.

        Parameters

        @@ -321,22 +694,23 @@

        Returns +

        getLong

        -
          +
          • getLong(name: string): number
          • -

            Get a long value at {@code pos}.

            +

            Get a long value at {@code pos}.

            Parameters

            @@ -353,22 +727,23 @@

            Returns number

        -
        +

        getShort

        -
          +
          • getShort(name: string): number
          • -

            Get a short value at {@code pos}.

            +

            Get a short value at {@code pos}.

            Parameters

            @@ -385,22 +760,23 @@

            Returns number

        -
        +

        getString

        -
          +
          • getString(name: string): string
          • -

            Get a string value at {@code pos}.

            +

            Get a string value at {@code pos}.

            Parameters

            @@ -417,22 +793,23 @@

            Returns string

        -
        +

        getValue

        -
          -
        • getValue(name: string): Object
          • +
            +
          • getValue(name: string): any
          • -

            Get an object value at {@code pos}.

            +

            Get an object value at {@code pos}.

            Parameters

            @@ -444,11 +821,301 @@
            name: string
          -

          Returns Object

          +

          Returns any

          the value or {@code null}

        +
        + +

        size

        +
          +
        • size(): number
          • +
        +
          +
        • + +
          +
          +

          Returns number

          +

          the tuple size

          +
          • +
        +
        +
        + +

        Static of

        +
          +
        • of(elt1: any): Tuple
          • +
        • of(elt1: any, elt2: any): Tuple
          • +
        • of(elt1: any, elt2: any, elt3: any): Tuple
          • +
        • of(elt1: any, elt2: any, elt3: any, elt4: any): Tuple
          • +
        • of(elt1: any, elt2: any, elt3: any, elt4: any, elt5: any): Tuple
          • +
        • of(elt1: any, elt2: any, elt3: any, elt4: any, elt5: any, elt6: any): Tuple
          • +
        +
          +
        • + +
          +
          +

          Create a tuple of one element.

          +
          +
          +

          Parameters

          +
            +
          • +
            elt1: any
            +
            +

            the first value

            +
            +
            • +
          +

          Returns Tuple

          +

          the tuple

          +
          • +
        • + +
          +
          +

          Create a tuple of two elements.

          +
          +
          +

          Parameters

          +
            +
          • +
            elt1: any
            +
            +

            the first value

            +
            +
            • +
          • +
            elt2: any
            +
            +

            the second value

            +
            +
            • +
          +

          Returns Tuple

          +

          the tuple

          +
          • +
        • + +
          +
          +

          Create a tuple of three elements.

          +
          +
          +

          Parameters

          +
            +
          • +
            elt1: any
            +
            +

            the first value

            +
            +
            • +
          • +
            elt2: any
            +
            +

            the second value

            +
            +
            • +
          • +
            elt3: any
            +
            +

            the third value

            +
            +
            • +
          +

          Returns Tuple

          +

          the tuple

          +
          • +
        • + +
          +
          +

          Create a tuple of four elements.

          +
          +
          +

          Parameters

          +
            +
          • +
            elt1: any
            +
            +

            the first value

            +
            +
            • +
          • +
            elt2: any
            +
            +

            the second value

            +
            +
            • +
          • +
            elt3: any
            +
            +

            the third value

            +
            +
            • +
          • +
            elt4: any
            +
            +

            the fourth value

            +
            +
            • +
          +

          Returns Tuple

          +

          the tuple

          +
          • +
        • + +
          +
          +

          Create a tuple of five elements.

          +
          +
          +

          Parameters

          +
            +
          • +
            elt1: any
            +
            +

            the first value

            +
            +
            • +
          • +
            elt2: any
            +
            +

            the second value

            +
            +
            • +
          • +
            elt3: any
            +
            +

            the third value

            +
            +
            • +
          • +
            elt4: any
            +
            +

            the fourth value

            +
            +
            • +
          • +
            elt5: any
            +
            +

            the fifth value

            +
            +
            • +
          +

          Returns Tuple

          +

          the tuple

          +
          • +
        • + +
          +
          +

          Create a tuple of six elements.

          +
          +
          +

          Parameters

          +
            +
          • +
            elt1: any
            +
            +

            the first value

            +
            +
            • +
          • +
            elt2: any
            +
            +

            the second value

            +
            +
            • +
          • +
            elt3: any
            +
            +

            the third value

            +
            +
            • +
          • +
            elt4: any
            +
            +

            the fourth value

            +
            +
            • +
          • +
            elt5: any
            +
            +

            the fifth value

            +
            +
            • +
          • +
            elt6: any
            +
            +

            the sixth value

            +
            +
            • +
          +

          Returns Tuple

          +

          the tuple

          +
          • +
        +
        +
        + +

        Static tuple

        + +
          +
        • + +
          +
          +

          Returns Tuple

          +

          a new empty tuple

          +
          • +
        +
        @@ -497,13 +1164,13 @@

        Returns Object PgPreparedQuery

        • -
      • +
      • PgResult
      • PgRowSet
        • -
      • +
      • PgStream
      • @@ -520,39 +1187,81 @@

        Returns Object Row

      diff --git a/docs/@reactiverse/reactive-pg-client/classes/tuple.html b/docs/@reactiverse/reactive-pg-client/classes/tuple.html index d6971b765..6137af2dc 100644 --- a/docs/@reactiverse/reactive-pg-client/classes/tuple.html +++ b/docs/@reactiverse/reactive-pg-client/classes/tuple.html @@ -69,6 +69,11 @@

      Hierarchy

      • Tuple +
    @@ -120,12 +125,12 @@

    addBoolean

  • -

    Add a boolean value at the end of the tuple.

    +

    Add a boolean value at the end of the tuple.

    Parameters

    @@ -152,12 +157,12 @@

    addBuffer

  • -

    Add a buffer value at the end of the tuple.

    +

    Add a buffer value at the end of the tuple.

    Parameters

    @@ -184,12 +189,12 @@

    addDouble

  • -

    Add a double value at the end of the tuple.

    +

    Add a double value at the end of the tuple.

    Parameters

    @@ -216,12 +221,12 @@

    addFloat

  • -

    Add a float value at the end of the tuple.

    +

    Add a float value at the end of the tuple.

    Parameters

    @@ -248,12 +253,12 @@

    addInteger

  • -

    Add an integer value at the end of the tuple.

    +

    Add an integer value at the end of the tuple.

    Parameters

    @@ -280,12 +285,12 @@

    addJson

  • -

    Add a json value at the end of the tuple.

    +

    Add a json value at the end of the tuple.

    Parameters

    @@ -312,12 +317,12 @@

    addLong

  • -

    Add a long value at the end of the tuple.

    +

    Add a long value at the end of the tuple.

    Parameters

    @@ -344,12 +349,12 @@

    addShort

  • -

    Add a short value at the end of the tuple.

    +

    Add a short value at the end of the tuple.

    Parameters

    @@ -376,12 +381,12 @@

    addString

  • -

    Add a string value at the end of the tuple.

    +

    Add a string value at the end of the tuple.

    Parameters

    @@ -408,12 +413,12 @@

    addValue

  • -

    Add an object value at the end of the tuple.

    +

    Add an object value at the end of the tuple.

    Parameters

    @@ -440,7 +445,7 @@

    clear

  • Returns void

    @@ -457,12 +462,12 @@

    getBoolean

  • -

    Get a boolean value at {@code pos}.

    +

    Get a boolean value at {@code pos}.

    Parameters

    @@ -489,12 +494,12 @@

    getBuffer

  • -

    Get a buffer value at {@code pos}.

    +

    Get a buffer value at {@code pos}.

    Parameters

    @@ -521,12 +526,12 @@

    getDouble

  • -

    Get a double value at {@code pos}.

    +

    Get a double value at {@code pos}.

    Parameters

    @@ -553,12 +558,12 @@

    getFloat

  • -

    Get a float value at {@code pos}.

    +

    Get a float value at {@code pos}.

    Parameters

    @@ -585,12 +590,12 @@

    getInteger

  • -

    Get an integer value at {@code pos}.

    +

    Get an integer value at {@code pos}.

    Parameters

    @@ -617,12 +622,12 @@

    getJson

  • -

    Get a json value at {@code pos}.

    +

    Get a json value at {@code pos}.

    Parameters

    @@ -649,12 +654,12 @@

    getLong

  • -

    Get a long value at {@code pos}.

    +

    Get a long value at {@code pos}.

    Parameters

    @@ -681,12 +686,12 @@

    getShort

  • -

    Get a short value at {@code pos}.

    +

    Get a short value at {@code pos}.

    Parameters

    @@ -713,12 +718,12 @@

    getString

  • -

    Get a string value at {@code pos}.

    +

    Get a string value at {@code pos}.

    Parameters

    @@ -739,18 +744,18 @@

    Returns string

    getValue

      -
    • getValue(pos: number): Object
      • +
    • getValue(pos: number): any
    • -

      Get an object value at {@code pos}.

      +

      Get an object value at {@code pos}.

      Parameters

      @@ -762,7 +767,7 @@
      pos: number
    -

    Returns Object

    +

    Returns any

    the value or {@code null}

    • @@ -777,7 +782,7 @@

    size

  • @@ -802,12 +807,12 @@

    Static of

  • -

    Create a tuple of one element.

    +

    Create a tuple of one element.

    Parameters

    @@ -825,12 +830,12 @@

    Returns
    -

    Create a tuple of two elements.

    +

    Create a tuple of two elements.

    Parameters

    @@ -854,12 +859,12 @@

    Returns
    -

    Create a tuple of three elements.

    +

    Create a tuple of three elements.

    Parameters

    @@ -889,12 +894,12 @@

    Returns
    -

    Create a tuple of four elements.

    +

    Create a tuple of four elements.

    Parameters

    @@ -930,12 +935,12 @@

    Returns
    -

    Create a tuple of five elements.

    +

    Create a tuple of five elements.

    Parameters

    @@ -977,12 +982,12 @@

    Returns
    -

    Create a tuple of six elements.

    +

    Create a tuple of six elements.

    Parameters

    @@ -1039,7 +1044,7 @@

    Static tuple

  • @@ -1097,13 +1102,13 @@

    Returns PgPreparedQuery

    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/globals.html b/docs/@reactiverse/reactive-pg-client/globals.html index 529371eb9..020ca2856 100644 --- a/docs/@reactiverse/reactive-pg-client/globals.html +++ b/docs/@reactiverse/reactive-pg-client/globals.html @@ -80,9 +80,9 @@

    Classes

  • PgPool
  • PgPoolOptions
  • PgPreparedQuery
    • -
  • PgResult
    • +
  • PgResult
  • PgRowSet
    • -
  • PgStream
    • +
  • PgStream
  • PgSubscriber
  • PgTransaction
  • Point
    • @@ -140,13 +140,13 @@

    Classes

  • PgPreparedQuery
    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@reactiverse/reactive-pg-client/index.html b/docs/@reactiverse/reactive-pg-client/index.html index b7df50492..9c704f020 100644 --- a/docs/@reactiverse/reactive-pg-client/index.html +++ b/docs/@reactiverse/reactive-pg-client/index.html @@ -143,13 +143,13 @@
  • PgPreparedQuery
    • -
  • +
  • PgResult
  • PgRowSet
    • -
  • +
  • PgStream
  • diff --git a/docs/@vertx/amqp-bridge/assets/js/search.js b/docs/@vertx/amqp-bridge/assets/js/search.js index 91f9a734d..9c3370944 100644 --- a/docs/@vertx/amqp-bridge/assets/js/search.js +++ b/docs/@vertx/amqp-bridge/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"AmqpBridgeOptions","url":"classes/amqpbridgeoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"connectTimeout","url":"classes/amqpbridgeoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":2,"kind":1024,"name":"containerId","url":"classes/amqpbridgeoptions.html#containerid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":3,"kind":1024,"name":"crlPaths","url":"classes/amqpbridgeoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":4,"kind":1024,"name":"crlValues","url":"classes/amqpbridgeoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":5,"kind":1024,"name":"enabledCipherSuites","url":"classes/amqpbridgeoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":6,"kind":1024,"name":"enabledSaslMechanisms","url":"classes/amqpbridgeoptions.html#enabledsaslmechanisms","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":7,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/amqpbridgeoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":8,"kind":1024,"name":"heartbeat","url":"classes/amqpbridgeoptions.html#heartbeat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":9,"kind":1024,"name":"hostnameVerificationAlgorithm","url":"classes/amqpbridgeoptions.html#hostnameverificationalgorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":10,"kind":1024,"name":"idleTimeout","url":"classes/amqpbridgeoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":11,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/amqpbridgeoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":12,"kind":1024,"name":"keyStoreOptions","url":"classes/amqpbridgeoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":13,"kind":1024,"name":"localAddress","url":"classes/amqpbridgeoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":14,"kind":1024,"name":"logActivity","url":"classes/amqpbridgeoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":15,"kind":1024,"name":"maxFrameSize","url":"classes/amqpbridgeoptions.html#maxframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":16,"kind":1024,"name":"metricsName","url":"classes/amqpbridgeoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":17,"kind":1024,"name":"openSslEngineOptions","url":"classes/amqpbridgeoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":18,"kind":1024,"name":"pemKeyCertOptions","url":"classes/amqpbridgeoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":19,"kind":1024,"name":"pemTrustOptions","url":"classes/amqpbridgeoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":20,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/amqpbridgeoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":21,"kind":1024,"name":"pfxTrustOptions","url":"classes/amqpbridgeoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":22,"kind":1024,"name":"proxyOptions","url":"classes/amqpbridgeoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":23,"kind":1024,"name":"receiveBufferSize","url":"classes/amqpbridgeoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":24,"kind":1024,"name":"reconnectAttempts","url":"classes/amqpbridgeoptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":25,"kind":1024,"name":"reconnectInterval","url":"classes/amqpbridgeoptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":26,"kind":1024,"name":"replyHandlingSupport","url":"classes/amqpbridgeoptions.html#replyhandlingsupport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":27,"kind":1024,"name":"reuseAddress","url":"classes/amqpbridgeoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":28,"kind":1024,"name":"reusePort","url":"classes/amqpbridgeoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":29,"kind":1024,"name":"sendBufferSize","url":"classes/amqpbridgeoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":30,"kind":1024,"name":"sniServerName","url":"classes/amqpbridgeoptions.html#sniservername","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":31,"kind":1024,"name":"soLinger","url":"classes/amqpbridgeoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":32,"kind":1024,"name":"ssl","url":"classes/amqpbridgeoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":33,"kind":1024,"name":"tcpCork","url":"classes/amqpbridgeoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":34,"kind":1024,"name":"tcpFastOpen","url":"classes/amqpbridgeoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":35,"kind":1024,"name":"tcpKeepAlive","url":"classes/amqpbridgeoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":36,"kind":1024,"name":"tcpNoDelay","url":"classes/amqpbridgeoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":37,"kind":1024,"name":"tcpQuickAck","url":"classes/amqpbridgeoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":38,"kind":1024,"name":"trafficClass","url":"classes/amqpbridgeoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":39,"kind":1024,"name":"trustAll","url":"classes/amqpbridgeoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":40,"kind":1024,"name":"trustStoreOptions","url":"classes/amqpbridgeoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":41,"kind":1024,"name":"useAlpn","url":"classes/amqpbridgeoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":42,"kind":1024,"name":"usePooledBuffers","url":"classes/amqpbridgeoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":43,"kind":1024,"name":"vhost","url":"classes/amqpbridgeoptions.html#vhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":44,"kind":1024,"name":"virtualHost","url":"classes/amqpbridgeoptions.html#virtualhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":45,"kind":128,"name":"AmqpBridge","url":"classes/amqpbridge.html","classes":"tsd-kind-class"},{"id":46,"kind":2048,"name":"create","url":"classes/amqpbridge.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"AmqpBridge"},{"id":47,"kind":2048,"name":"start","url":"classes/amqpbridge.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"},{"id":48,"kind":2048,"name":"createConsumer","url":"classes/amqpbridge.html#createconsumer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"},{"id":49,"kind":2048,"name":"createProducer","url":"classes/amqpbridge.html#createproducer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"},{"id":50,"kind":2048,"name":"close","url":"classes/amqpbridge.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"},{"id":51,"kind":2048,"name":"endHandler","url":"classes/amqpbridge.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"AmqpBridgeOptions","url":"classes/amqpbridgeoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/amqpbridgeoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":2,"kind":2048,"name":"getConnectTimeout","url":"classes/amqpbridgeoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":3,"kind":2048,"name":"setConnectTimeout","url":"classes/amqpbridgeoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":4,"kind":2048,"name":"getContainerId","url":"classes/amqpbridgeoptions.html#getcontainerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":5,"kind":2048,"name":"setContainerId","url":"classes/amqpbridgeoptions.html#setcontainerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":6,"kind":2048,"name":"getCrlPaths","url":"classes/amqpbridgeoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":7,"kind":2048,"name":"addCrlPath","url":"classes/amqpbridgeoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":8,"kind":2048,"name":"getCrlValues","url":"classes/amqpbridgeoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":9,"kind":2048,"name":"addCrlValue","url":"classes/amqpbridgeoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":10,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/amqpbridgeoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":11,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/amqpbridgeoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":12,"kind":2048,"name":"getEnabledSaslMechanisms","url":"classes/amqpbridgeoptions.html#getenabledsaslmechanisms","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":13,"kind":2048,"name":"addEnabledSaslMechanism","url":"classes/amqpbridgeoptions.html#addenabledsaslmechanism","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":14,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/amqpbridgeoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":15,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/amqpbridgeoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":16,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/amqpbridgeoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":17,"kind":2048,"name":"getHeartbeat","url":"classes/amqpbridgeoptions.html#getheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":18,"kind":2048,"name":"setHeartbeat","url":"classes/amqpbridgeoptions.html#setheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":19,"kind":2048,"name":"getHostnameVerificationAlgorithm","url":"classes/amqpbridgeoptions.html#gethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":20,"kind":2048,"name":"setHostnameVerificationAlgorithm","url":"classes/amqpbridgeoptions.html#sethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":21,"kind":2048,"name":"getIdleTimeout","url":"classes/amqpbridgeoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":22,"kind":2048,"name":"setIdleTimeout","url":"classes/amqpbridgeoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":23,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/amqpbridgeoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":24,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/amqpbridgeoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":25,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/amqpbridgeoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":26,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/amqpbridgeoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":27,"kind":2048,"name":"getKeyStoreOptions","url":"classes/amqpbridgeoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":28,"kind":2048,"name":"setKeyStoreOptions","url":"classes/amqpbridgeoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":29,"kind":2048,"name":"getLocalAddress","url":"classes/amqpbridgeoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":30,"kind":2048,"name":"setLocalAddress","url":"classes/amqpbridgeoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":31,"kind":2048,"name":"getLogActivity","url":"classes/amqpbridgeoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":32,"kind":2048,"name":"setLogActivity","url":"classes/amqpbridgeoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":33,"kind":2048,"name":"getMaxFrameSize","url":"classes/amqpbridgeoptions.html#getmaxframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":34,"kind":2048,"name":"setMaxFrameSize","url":"classes/amqpbridgeoptions.html#setmaxframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":35,"kind":2048,"name":"getMetricsName","url":"classes/amqpbridgeoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":36,"kind":2048,"name":"setMetricsName","url":"classes/amqpbridgeoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":37,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/amqpbridgeoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":38,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/amqpbridgeoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":39,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/amqpbridgeoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":40,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/amqpbridgeoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":41,"kind":2048,"name":"getPemTrustOptions","url":"classes/amqpbridgeoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":42,"kind":2048,"name":"setPemTrustOptions","url":"classes/amqpbridgeoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":43,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/amqpbridgeoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":44,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/amqpbridgeoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":45,"kind":2048,"name":"getPfxTrustOptions","url":"classes/amqpbridgeoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":46,"kind":2048,"name":"setPfxTrustOptions","url":"classes/amqpbridgeoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":47,"kind":2048,"name":"getProxyOptions","url":"classes/amqpbridgeoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":48,"kind":2048,"name":"setProxyOptions","url":"classes/amqpbridgeoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":49,"kind":2048,"name":"getReceiveBufferSize","url":"classes/amqpbridgeoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":50,"kind":2048,"name":"setReceiveBufferSize","url":"classes/amqpbridgeoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":51,"kind":2048,"name":"getReconnectAttempts","url":"classes/amqpbridgeoptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":52,"kind":2048,"name":"setReconnectAttempts","url":"classes/amqpbridgeoptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":53,"kind":2048,"name":"getReconnectInterval","url":"classes/amqpbridgeoptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":54,"kind":2048,"name":"setReconnectInterval","url":"classes/amqpbridgeoptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":55,"kind":2048,"name":"isReplyHandlingSupport","url":"classes/amqpbridgeoptions.html#isreplyhandlingsupport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":56,"kind":2048,"name":"setReplyHandlingSupport","url":"classes/amqpbridgeoptions.html#setreplyhandlingsupport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":57,"kind":2048,"name":"isReuseAddress","url":"classes/amqpbridgeoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":58,"kind":2048,"name":"setReuseAddress","url":"classes/amqpbridgeoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":59,"kind":2048,"name":"isReusePort","url":"classes/amqpbridgeoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":60,"kind":2048,"name":"setReusePort","url":"classes/amqpbridgeoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":61,"kind":2048,"name":"getSendBufferSize","url":"classes/amqpbridgeoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":62,"kind":2048,"name":"setSendBufferSize","url":"classes/amqpbridgeoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":63,"kind":2048,"name":"getSniServerName","url":"classes/amqpbridgeoptions.html#getsniservername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":64,"kind":2048,"name":"setSniServerName","url":"classes/amqpbridgeoptions.html#setsniservername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":65,"kind":2048,"name":"getSoLinger","url":"classes/amqpbridgeoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":66,"kind":2048,"name":"setSoLinger","url":"classes/amqpbridgeoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":67,"kind":2048,"name":"isSsl","url":"classes/amqpbridgeoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":68,"kind":2048,"name":"setSsl","url":"classes/amqpbridgeoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":69,"kind":2048,"name":"isTcpCork","url":"classes/amqpbridgeoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":70,"kind":2048,"name":"setTcpCork","url":"classes/amqpbridgeoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":71,"kind":2048,"name":"isTcpFastOpen","url":"classes/amqpbridgeoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":72,"kind":2048,"name":"setTcpFastOpen","url":"classes/amqpbridgeoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":73,"kind":2048,"name":"isTcpKeepAlive","url":"classes/amqpbridgeoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":74,"kind":2048,"name":"setTcpKeepAlive","url":"classes/amqpbridgeoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":75,"kind":2048,"name":"isTcpNoDelay","url":"classes/amqpbridgeoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":76,"kind":2048,"name":"setTcpNoDelay","url":"classes/amqpbridgeoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":77,"kind":2048,"name":"isTcpQuickAck","url":"classes/amqpbridgeoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":78,"kind":2048,"name":"setTcpQuickAck","url":"classes/amqpbridgeoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":79,"kind":2048,"name":"getTrafficClass","url":"classes/amqpbridgeoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":80,"kind":2048,"name":"setTrafficClass","url":"classes/amqpbridgeoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":81,"kind":2048,"name":"isTrustAll","url":"classes/amqpbridgeoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":82,"kind":2048,"name":"setTrustAll","url":"classes/amqpbridgeoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":83,"kind":2048,"name":"getTrustStoreOptions","url":"classes/amqpbridgeoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":84,"kind":2048,"name":"setTrustStoreOptions","url":"classes/amqpbridgeoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":85,"kind":2048,"name":"isUseAlpn","url":"classes/amqpbridgeoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":86,"kind":2048,"name":"setUseAlpn","url":"classes/amqpbridgeoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":87,"kind":2048,"name":"isUsePooledBuffers","url":"classes/amqpbridgeoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":88,"kind":2048,"name":"setUsePooledBuffers","url":"classes/amqpbridgeoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":89,"kind":2048,"name":"getVhost","url":"classes/amqpbridgeoptions.html#getvhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":90,"kind":2048,"name":"setVhost","url":"classes/amqpbridgeoptions.html#setvhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":91,"kind":2048,"name":"getVirtualHost","url":"classes/amqpbridgeoptions.html#getvirtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":92,"kind":2048,"name":"setVirtualHost","url":"classes/amqpbridgeoptions.html#setvirtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridgeOptions"},{"id":93,"kind":128,"name":"AmqpBridge","url":"classes/amqpbridge.html","classes":"tsd-kind-class"},{"id":94,"kind":2048,"name":"create","url":"classes/amqpbridge.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"AmqpBridge"},{"id":95,"kind":2048,"name":"start","url":"classes/amqpbridge.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"},{"id":96,"kind":2048,"name":"createConsumer","url":"classes/amqpbridge.html#createconsumer","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"AmqpBridge"},{"id":97,"kind":2048,"name":"createProducer","url":"classes/amqpbridge.html#createproducer","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"AmqpBridge"},{"id":98,"kind":2048,"name":"close","url":"classes/amqpbridge.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"},{"id":99,"kind":2048,"name":"endHandler","url":"classes/amqpbridge.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AmqpBridge"}]}; \ No newline at end of file diff --git a/docs/@vertx/amqp-bridge/classes/amqpbridge.html b/docs/@vertx/amqp-bridge/classes/amqpbridge.html index 5e4dab20c..7692c2d2c 100644 --- a/docs/@vertx/amqp-bridge/classes/amqpbridge.html +++ b/docs/@vertx/amqp-bridge/classes/amqpbridge.html @@ -80,8 +80,8 @@

    Index

    Methods

    • close
      • -
    • createConsumer
      • -
    • createProducer
      • +
    • createConsumer
      • +
    • createProducer
    • endHandler
    • start
    • create
      • @@ -102,12 +102,12 @@

      close

    • -

      Shuts the bridge down, closing the underlying connection.

      +

      Shuts the bridge down, closing the underlying connection.

      Parameters

      @@ -120,17 +120,20 @@
      resultHandler: function
        • -
        • (result: AsyncResult<void>): void
          • +
        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

        • Parameters

          • -
            result: AsyncResult<void>
            +
            res: AsyncResult<void>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<void>> +

        • @@ -141,22 +144,22 @@

        Returns void

    • -
    +

    createConsumer

    -
      -
    • createConsumer(amqpAddress: string): MessageConsumer
      • +
        +
      • createConsumer<T>(amqpAddress: string): MessageConsumer<T>
      • -

        Creates a consumer on the given AMQP address.

        +

        Creates a consumer on the given AMQP address.

        This method MUST be called from the bridge Context thread, as used in the result handler callback from the start methods. The bridge MUST be successfully started before the method is called.

        @@ -168,6 +171,12 @@

        createConsumer

        +

        Type parameters

        +
          +
        • +

          T

          +
          • +

        Parameters

        • @@ -177,27 +186,27 @@
          amqpAddress: string
        -

        Returns MessageConsumer

        +

        Returns MessageConsumer<T>

        the consumer

    -
    +

    createProducer

    -
    -

    Properties

    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    containerId

    -
    containerId: string
    - -
    -
    -

    Sets the value to use as the container-id field in the AMQP Open frame. Some servers and clients use this for the - concept of a 'Client ID'. Defaults to null, which indicates a value will be generated by the bridge when the - underlying connection is made.

    -
    -
    -
    param
    -

    the container-id to use

    -
    -
    returns
    -

    the options

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    addEnabledSaslMechanism

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSaslMechanisms: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    enabledSaslMechanisms

    -
    enabledSaslMechanisms: string
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): AmqpBridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    heartbeat

    -
    heartbeat: number
    - +
    + +

    getContainerId

    +
      +
    • getContainerId(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the value to use as the container-id field in the AMQP Open frame. Some servers and clients use this for the + concept of a 'Client ID'. Defaults to null, which indicates a value will be generated by the bridge when the + underlying connection is made.

      +
      +
      +

      Returns string

      +

      the options

      +
      • +
    -
    - -

    hostnameVerificationAlgorithm

    -
    hostnameVerificationAlgorithm: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getEnabledSaslMechanisms

    +
      +
    • getEnabledSaslMechanisms(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getHeartbeat

    +
      +
    • getHeartbeat(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getHostnameVerificationAlgorithm

    +
      +
    • getHostnameVerificationAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    +
    +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    +
    +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getMaxFrameSize

    +
      +
    • getMaxFrameSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +

      Returns ProxyOptions

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReconnectAttempts

    +
      +
    • getReconnectAttempts(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReconnectInterval

    +
      +
    • getReconnectInterval(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSniServerName

    +
      +
    • getSniServerName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getVhost

    +
      +
    • getVhost(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the value to use as the hostname field in the AMQP Open frame. Defaults to null, which indicates the hostname + value given when starting the bridge will be used to populate the hostname field.

      +
      +
      +
      deprecated
      +

      use {@link #setVirtualHost(String)} option instead.

      +
      +
      +
      +

      Returns string

      +

      the options

      +
      • +
    +
    +
    + +

    getVirtualHost

    +
      +
    • getVirtualHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    isReplyHandlingSupport

    +
      +
    • isReplyHandlingSupport(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether the bridge should try to enable support for sending messages with a reply handler set, and replying to + messages using the message reply methods. Defaults to true. If the server does not advertise support for + 'anonymous sender' links then the bridge won't support reply handling regardless of this setting.

      +
      +
      +

      Returns boolean

      +

      the options

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    +
    +
    + +

    setContainerId

    + +
      +
    • + +
      +
      +

      Sets the value to use as the container-id field in the AMQP Open frame. Some servers and clients use this for the + concept of a 'Client ID'. Defaults to null, which indicates a value will be generated by the bridge when the + underlying connection is made.

      +
      +
      +

      Parameters

      +
        +
      • +
        containerId: string
        +
        +

        the container-id to use

        +
        +
        • +
      +

      Returns AmqpBridgeOptions

      +

      the options

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): AmqpBridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    +
    +
    + +

    setHeartbeat

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        heartbeat: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    +
    +
    + +

    setHostnameVerificationAlgorithm

    +
      +
    • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): AmqpBridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        hostnameVerificationAlgorithm: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): AmqpBridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - +
    + +

    setLocalAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    maxFrameSize

    -
    maxFrameSize: number
    - +
    + +

    setMaxFrameSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxFrameSize: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - +
    + +

    setMetricsName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): AmqpBridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - +
    + +

    setProxyOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    reconnectAttempts

    -
    reconnectAttempts: number
    - +
    + +

    setReconnectAttempts

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectAttempts: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    reconnectInterval

    -
    reconnectInterval: number
    - +
    + +

    setReconnectInterval

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectInterval: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    replyHandlingSupport

    -
    replyHandlingSupport: boolean
    - -
    -
    -

    Sets whether the bridge should try to enable support for sending messages with a reply handler set, and replying to - messages using the message reply methods. Defaults to true. If the server does not advertise support for - 'anonymous sender' links then the bridge won't support reply handling regardless of this setting.

    -
    -
    -
    param
    -

    should attempt be made to enable support for sending messages with a reply handler

    -
    -
    returns
    -

    the options

    -
    -
    -
    +
    + +

    setReplyHandlingSupport

    + +
      +
    • + +
      +
      +

      Sets whether the bridge should try to enable support for sending messages with a reply handler set, and replying to + messages using the message reply methods. Defaults to true. If the server does not advertise support for + 'anonymous sender' links then the bridge won't support reply handling regardless of this setting.

      +
      +
      +

      Parameters

      +
        +
      • +
        replyHandlingSupport: boolean
        +
        +

        should attempt be made to enable support for sending messages with a reply handler

        +
        +
        • +
      +

      Returns AmqpBridgeOptions

      +

      the options

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    sniServerName

    -
    sniServerName: string
    - +
    + +

    setSniServerName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sniServerName: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - +
    + +

    setTrustAll

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    -
    - -

    vhost

    -
    vhost: string
    - -
    -
    -

    Sets the value to use as the hostname field in the AMQP Open frame. Defaults to null, which indicates the hostname - value given when starting the bridge will be used to populate the hostname field.

    -
    -
    -
    param
    -

    the value to use as the hostname field in the AMQP Open frame to indicate a vhost.

    -
    -
    returns
    -

    the options

    -
    -
    deprecated
    -

    use {@link #setVirtualHost(String)} option instead.

    -
    -
    -
    +
    + +

    setVhost

    + +
      +
    • + +
      +
      +

      Sets the value to use as the hostname field in the AMQP Open frame. Defaults to null, which indicates the hostname + value given when starting the bridge will be used to populate the hostname field.

      +
      +
      +
      deprecated
      +

      use {@link #setVirtualHost(String)} option instead.

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        vhost: string
        +
        +

        the value to use as the hostname field in the AMQP Open frame to indicate a vhost.

        +
        +
        • +
      +

      Returns AmqpBridgeOptions

      +

      the options

      +
      • +
    -
    - -

    virtualHost

    -
    virtualHost: string
    - +
    + +

    setVirtualHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        virtualHost: string
        +
        • +
      +

      Returns AmqpBridgeOptions

      +
      • +
    @@ -637,137 +2126,281 @@

    virtualHost

  • AmqpBridgeOptions
    • diff --git a/docs/@vertx/auth-common/assets/js/search.js b/docs/@vertx/auth-common/assets/js/search.js index e7883331f..24317939a 100644 --- a/docs/@vertx/auth-common/assets/js/search.js +++ b/docs/@vertx/auth-common/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","256":"Interface","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"AuthProvider","url":"classes/authprovider.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"authenticate","url":"classes/authprovider.html#authenticate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AuthProvider"},{"id":2,"kind":128,"name":"ChainAuth","url":"classes/chainauth.html","classes":"tsd-kind-class"},{"id":3,"kind":2048,"name":"create","url":"classes/chainauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ChainAuth"},{"id":4,"kind":2048,"name":"append","url":"classes/chainauth.html#append","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ChainAuth"},{"id":5,"kind":2048,"name":"remove","url":"classes/chainauth.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ChainAuth"},{"id":6,"kind":2048,"name":"clear","url":"classes/chainauth.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ChainAuth"},{"id":7,"kind":128,"name":"User","url":"classes/user.html","classes":"tsd-kind-class"},{"id":8,"kind":2048,"name":"isAuthorized","url":"classes/user.html#isauthorized","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":9,"kind":2048,"name":"isAuthorised","url":"classes/user.html#isauthorised","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":10,"kind":2048,"name":"clearCache","url":"classes/user.html#clearcache","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":11,"kind":2048,"name":"principal","url":"classes/user.html#principal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":12,"kind":2048,"name":"setAuthProvider","url":"classes/user.html#setauthprovider","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":13,"kind":128,"name":"VertxContextPRNG","url":"classes/vertxcontextprng.html","classes":"tsd-kind-class"},{"id":14,"kind":2048,"name":"current","url":"classes/vertxcontextprng.html#current","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"VertxContextPRNG"},{"id":15,"kind":2048,"name":"nextString","url":"classes/vertxcontextprng.html#nextstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxContextPRNG"},{"id":16,"kind":2048,"name":"nextInt","url":"classes/vertxcontextprng.html#nextint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxContextPRNG"},{"id":17,"kind":256,"name":"AuthOptions","url":"interfaces/authoptions.html","classes":"tsd-kind-interface"},{"id":18,"kind":128,"name":"KeyStoreOptions","url":"classes/keystoreoptions.html","classes":"tsd-kind-class"},{"id":19,"kind":1024,"name":"password","url":"classes/keystoreoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":20,"kind":1024,"name":"path","url":"classes/keystoreoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":21,"kind":1024,"name":"type","url":"classes/keystoreoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":22,"kind":128,"name":"PubSecKeyOptions","url":"classes/pubseckeyoptions.html","classes":"tsd-kind-class"},{"id":23,"kind":1024,"name":"algorithm","url":"classes/pubseckeyoptions.html#algorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":24,"kind":1024,"name":"certificate","url":"classes/pubseckeyoptions.html#certificate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":25,"kind":1024,"name":"publicKey","url":"classes/pubseckeyoptions.html#publickey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":26,"kind":1024,"name":"secretKey","url":"classes/pubseckeyoptions.html#secretkey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":27,"kind":1024,"name":"symmetric","url":"classes/pubseckeyoptions.html#symmetric","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":28,"kind":128,"name":"SecretOptions","url":"classes/secretoptions.html","classes":"tsd-kind-class"},{"id":29,"kind":1024,"name":"secret","url":"classes/secretoptions.html#secret","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SecretOptions"},{"id":30,"kind":1024,"name":"type","url":"classes/secretoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SecretOptions"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"AuthProvider","url":"classes/authprovider.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"authenticate","url":"classes/authprovider.html#authenticate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AuthProvider"},{"id":2,"kind":128,"name":"ChainAuth","url":"classes/chainauth.html","classes":"tsd-kind-class"},{"id":3,"kind":2048,"name":"create","url":"classes/chainauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ChainAuth"},{"id":4,"kind":2048,"name":"append","url":"classes/chainauth.html#append","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ChainAuth"},{"id":5,"kind":2048,"name":"remove","url":"classes/chainauth.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ChainAuth"},{"id":6,"kind":2048,"name":"clear","url":"classes/chainauth.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ChainAuth"},{"id":7,"kind":2048,"name":"authenticate","url":"classes/chainauth.html#authenticate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"ChainAuth"},{"id":8,"kind":128,"name":"HashingAlgorithm","url":"classes/hashingalgorithm.html","classes":"tsd-kind-class"},{"id":9,"kind":2048,"name":"id","url":"classes/hashingalgorithm.html#id","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingAlgorithm"},{"id":10,"kind":2048,"name":"params","url":"classes/hashingalgorithm.html#params","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingAlgorithm"},{"id":11,"kind":2048,"name":"needsSeparator","url":"classes/hashingalgorithm.html#needsseparator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingAlgorithm"},{"id":12,"kind":128,"name":"HashingStrategy","url":"classes/hashingstrategy.html","classes":"tsd-kind-class"},{"id":13,"kind":2048,"name":"load","url":"classes/hashingstrategy.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HashingStrategy"},{"id":14,"kind":2048,"name":"hash","url":"classes/hashingstrategy.html#hash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingStrategy"},{"id":15,"kind":2048,"name":"verify","url":"classes/hashingstrategy.html#verify","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingStrategy"},{"id":16,"kind":2048,"name":"get","url":"classes/hashingstrategy.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingStrategy"},{"id":17,"kind":2048,"name":"put","url":"classes/hashingstrategy.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashingStrategy"},{"id":18,"kind":128,"name":"User","url":"classes/user.html","classes":"tsd-kind-class"},{"id":19,"kind":2048,"name":"isAuthorized","url":"classes/user.html#isauthorized","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":20,"kind":2048,"name":"isAuthorised","url":"classes/user.html#isauthorised","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":21,"kind":2048,"name":"clearCache","url":"classes/user.html#clearcache","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":22,"kind":2048,"name":"principal","url":"classes/user.html#principal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":23,"kind":2048,"name":"setAuthProvider","url":"classes/user.html#setauthprovider","classes":"tsd-kind-method tsd-parent-kind-class","parent":"User"},{"id":24,"kind":128,"name":"VertxContextPRNG","url":"classes/vertxcontextprng.html","classes":"tsd-kind-class"},{"id":25,"kind":2048,"name":"current","url":"classes/vertxcontextprng.html#current","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"VertxContextPRNG"},{"id":26,"kind":2048,"name":"nextString","url":"classes/vertxcontextprng.html#nextstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxContextPRNG"},{"id":27,"kind":2048,"name":"nextInt","url":"classes/vertxcontextprng.html#nextint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxContextPRNG"},{"id":28,"kind":128,"name":"AuthOptions","url":"classes/authoptions.html","classes":"tsd-kind-class"},{"id":29,"kind":512,"name":"constructor","url":"classes/authoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"AuthOptions"},{"id":30,"kind":128,"name":"KeyStoreOptions","url":"classes/keystoreoptions.html","classes":"tsd-kind-class"},{"id":31,"kind":512,"name":"constructor","url":"classes/keystoreoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":32,"kind":2048,"name":"getPassword","url":"classes/keystoreoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":33,"kind":2048,"name":"setPassword","url":"classes/keystoreoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":34,"kind":2048,"name":"getPath","url":"classes/keystoreoptions.html#getpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":35,"kind":2048,"name":"setPath","url":"classes/keystoreoptions.html#setpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":36,"kind":2048,"name":"getType","url":"classes/keystoreoptions.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":37,"kind":2048,"name":"setType","url":"classes/keystoreoptions.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyStoreOptions"},{"id":38,"kind":128,"name":"PubSecKeyOptions","url":"classes/pubseckeyoptions.html","classes":"tsd-kind-class"},{"id":39,"kind":512,"name":"constructor","url":"classes/pubseckeyoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":40,"kind":2048,"name":"getAlgorithm","url":"classes/pubseckeyoptions.html#getalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":41,"kind":2048,"name":"setAlgorithm","url":"classes/pubseckeyoptions.html#setalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":42,"kind":2048,"name":"isCertificate","url":"classes/pubseckeyoptions.html#iscertificate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":43,"kind":2048,"name":"setCertificate","url":"classes/pubseckeyoptions.html#setcertificate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":44,"kind":2048,"name":"getPublicKey","url":"classes/pubseckeyoptions.html#getpublickey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":45,"kind":2048,"name":"setPublicKey","url":"classes/pubseckeyoptions.html#setpublickey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":46,"kind":2048,"name":"getSecretKey","url":"classes/pubseckeyoptions.html#getsecretkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":47,"kind":2048,"name":"setSecretKey","url":"classes/pubseckeyoptions.html#setsecretkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":48,"kind":2048,"name":"isSymmetric","url":"classes/pubseckeyoptions.html#issymmetric","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":49,"kind":2048,"name":"setSymmetric","url":"classes/pubseckeyoptions.html#setsymmetric","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PubSecKeyOptions"},{"id":50,"kind":128,"name":"SecretOptions","url":"classes/secretoptions.html","classes":"tsd-kind-class"},{"id":51,"kind":512,"name":"constructor","url":"classes/secretoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SecretOptions"},{"id":52,"kind":2048,"name":"getSecret","url":"classes/secretoptions.html#getsecret","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SecretOptions"},{"id":53,"kind":2048,"name":"setSecret","url":"classes/secretoptions.html#setsecret","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SecretOptions"},{"id":54,"kind":2048,"name":"getType","url":"classes/secretoptions.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SecretOptions"},{"id":55,"kind":2048,"name":"setType","url":"classes/secretoptions.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SecretOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/mongo-client/classes/bulkwriteoptions.html b/docs/@vertx/auth-common/classes/authoptions.html similarity index 71% rename from docs/@vertx/mongo-client/classes/bulkwriteoptions.html rename to docs/@vertx/auth-common/classes/authoptions.html index 7748e95f9..9fd20038a 100644 --- a/docs/@vertx/mongo-client/classes/bulkwriteoptions.html +++ b/docs/@vertx/auth-common/classes/authoptions.html @@ -3,7 +3,7 @@ - BulkWriteOptions | @vertx/mongo-client + AuthOptions | @vertx/auth-common @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/mongo-client + @vertx/auth-common
    @@ -54,10 +54,10 @@ Globals
  • - BulkWriteOptions + AuthOptions
    • -

    Class BulkWriteOptions

    +

    Class AuthOptions

    @@ -68,7 +68,7 @@

    Class BulkWriteOptions

    Hierarchy

    • - BulkWriteOptions + AuthOptions
    @@ -77,60 +77,47 @@

    Index

    -

    Properties

    +

    Constructors

    -

    Properties

    -
    - -

    ordered

    -
    ordered: boolean
    - -
    -
    -

    Set the ordered option

    -
    -
    -
    param
    - 
          the ordered option
    -
    returns
    -

    fluent reference to this

    -
    -
    -
    -
    -
    - -

    writeOption

    -
    writeOption: WriteOption
    - -
    -
    -

    Set the write option

    -
    -
    -
    param
    - 
          the write option
    -
    returns
    -

    fluent reference to this

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns AuthOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns AuthOptions

      +
      • +
    @@ -144,44 +131,44 @@

    writeOption

    diff --git a/docs/@vertx/auth-common/classes/authprovider.html b/docs/@vertx/auth-common/classes/authprovider.html index c13d6ed07..6cd388d8e 100644 --- a/docs/@vertx/auth-common/classes/authprovider.html +++ b/docs/@vertx/auth-common/classes/authprovider.html @@ -69,6 +69,11 @@

    Hierarchy

    @@ -97,12 +102,12 @@

    authenticate

  • -

    Authenticate a user. +

    Authenticate a user.

    The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based @@ -126,6 +131,11 @@

    authInfo: object

    The auth information

    +
      +
    • +
      [key: string]: any
      +
      • +
  • resultHandler: function
    @@ -135,17 +145,20 @@
    resultHandler: function
      • -
      • (result: AsyncResult<User>): void
        • +
      • (res: AsyncResult<User>): void | Handler<AsyncResult<User>>

      • Parameters

        • -
          result: AsyncResult<User>
          +
          res: AsyncResult<User>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<User>> +

      • @@ -168,6 +181,9 @@

      Returns void diff --git a/docs/@vertx/auth-common/classes/chainauth.html b/docs/@vertx/auth-common/classes/chainauth.html index d4bd77470..b7ead5679 100644 --- a/docs/@vertx/auth-common/classes/chainauth.html +++ b/docs/@vertx/auth-common/classes/chainauth.html @@ -68,7 +68,12 @@

      Class ChainAuth

      Hierarchy

    • @@ -80,6 +85,7 @@

    Index

    Methods

    • append
      • +
    • authenticate
    • clear
    • remove
    • create
      • @@ -100,12 +106,12 @@

      append

    • -

      Appends a auth provider to the chain.

      +

      Appends a auth provider to the chain.

      Parameters

      @@ -122,6 +128,84 @@

      Returns + +

      authenticate

      +
        +
      • authenticate(authInfo: object, resultHandler: function): void
        • +
      +
        +
      • + +
        +
        +

        Authenticate a user. +

        + The first argument is a JSON object containing information for authenticating the user. What this actually contains + depends on the specific implementation. In the case of a simple username/password based + authentication it is likely to contain a JSON object with the following structure: + 

        +   {
+     "username": "tim",
+     "password": "mypassword"
+   }
+
        + For other types of authentication it contain different information - for example a JWT token or OAuth bearer token. +

        + If the user is successfully authenticated a User object is passed to the handler in an {@link io.vertx.core.AsyncResult}. + The user object can then be used for authorisation.

        +
        +
        +

        Parameters

        +
          +
        • +
          authInfo: object
          +
          +

          The auth information

          +
          +
            +
          • +
            [key: string]: any
            +
            • +
          +
          • +
        • +
          resultHandler: function
          +
          +

          The result handler

          +
          +
            +
          • +
              +
            • (res: AsyncResult<User>): void | Handler<AsyncResult<User>>
              • +
            +
              +
            • +

              Parameters

              +
                +
              • +
                res: AsyncResult<User>
                +
                • +
              +

              Returns void + | + Handler<AsyncResult<User>> +

              +
              • +
            +
            • +
          +
          • +
        +

        Returns void

        +
        • +
      +

    clear

    @@ -132,12 +216,12 @@

    clear

  • -

    Clears the chain.

    +

    Clears the chain.

    Returns void

    @@ -154,12 +238,12 @@

    remove

  • -

    Removes a provider from the chain.

    +

    Removes a provider from the chain.

    Parameters

    @@ -186,12 +270,12 @@

    Static create

  • -

    Create a Chainable Auth Provider auth provider

    +

    Create a Chainable Auth Provider auth provider

    Returns ChainAuth

    @@ -211,6 +295,9 @@

    Returns diff --git a/docs/@vertx/sql-common/classes/updateresult.html b/docs/@vertx/auth-common/classes/hashingalgorithm.html similarity index 61% rename from docs/@vertx/sql-common/classes/updateresult.html rename to docs/@vertx/auth-common/classes/hashingalgorithm.html index e2c38b959..9b18cec97 100644 --- a/docs/@vertx/sql-common/classes/updateresult.html +++ b/docs/@vertx/auth-common/classes/hashingalgorithm.html @@ -3,7 +3,7 @@ - UpdateResult | @vertx/sql-common + HashingAlgorithm | @vertx/auth-common @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/auth-common
    @@ -54,10 +54,10 @@ Globals

  • - UpdateResult + HashingAlgorithm
    • -

    Class UpdateResult

    +

    Class HashingAlgorithm

    @@ -68,7 +68,7 @@

    Class UpdateResult

    Hierarchy

    • - UpdateResult + HashingAlgorithm
    @@ -77,56 +77,86 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    keys

    -
    keys: any[]
    - -
    -
    -

    Get any generated keys

    -
    -
    -
    returns
    -

    generated keys

    -
    -
    -
    +

    Methods

    +
    + +

    id

    +
      +
    • id(): string
      • +
    +
      +
    • + +
      +
      +

      return the symbolic name for the algorithm

      +
      +
      +

      Returns string

      +

      short id e.g.: sha512.

      +
      • +
    -
    - -

    updated

    -
    updated: number
    - -
    -
    -

    Get the number of rows updated

    -
    -
    -
    returns
    -

    number of rows updated

    -
    -
    -
    +
    + +

    needsSeparator

    +
      +
    • needsSeparator(): boolean
      • +
    +
      +
    • + +
      +
      +

      Should the encoded string use the default separator to split fields.

      +
      +
      +

      Returns boolean

      +

      true by default.

      +
      • +
    +
    +
    + +

    params

    +
      +
    • params(): string[]
      • +
    +
      +
    • + +
      +
      +

      return the list of param names required for this algorithm.

      +
      +
      +

      Returns string[]

      +

      set of param names.

      +
      • +
    @@ -140,50 +170,50 @@

    updated

    diff --git a/docs/@vertx/auth-common/classes/hashingstrategy.html b/docs/@vertx/auth-common/classes/hashingstrategy.html new file mode 100644 index 000000000..16405ca05 --- /dev/null +++ b/docs/@vertx/auth-common/classes/hashingstrategy.html @@ -0,0 +1,415 @@ + + + + + + HashingStrategy | @vertx/auth-common + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class HashingStrategy

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + HashingStrategy +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    get

    + +
      +
    • + +
      +
      +

      Get an algorithm interface by its Id

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the algorithm id

        +
        +
        • +
      +

      Returns HashingAlgorithm

      +

      the algorithm

      +
      • +
    +
    +
    + +

    hash

    +
      +
    • hash(id: string, params: object, salt: string, password: string): string
      • +
    +
      +
    • + +
      +
      +

      Hashes a password.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the algorithm id

        +
        +
        • +
      • +
        params: object
        +
        +

        the algorithm specific paramters

        +
        +
          +
        • +
          [key: string]: string
          +
          • +
        +
        • +
      • +
        salt: string
        +
        +

        the given salt

        +
        +
        • +
      • +
        password: string
        +
        +

        the given password

        +
        +
        • +
      +

      Returns string

      +

      the hashed string

      +
      • +
    +
    +
    + +

    put

    + +
      +
    • + +
      +
      +

      Put or replace an algorithm into the list of system loaded algorithms.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the algorithm id

        +
        +
        • +
      • +
        algorithm: HashingAlgorithm
        +
        +

        the implementation

        +
        +
        • +
      +

      Returns HashingStrategy

      +

      self

      +
      • +
    +
    +
    + +

    verify

    +
      +
    • verify(hash: string, password: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Time constant password check. Regardless of the check, this algorithm executes the same number of + checks regardless of the correctly number of characters

      +
      +
      +

      Parameters

      +
        +
      • +
        hash: string
        +
        +

        the hash to verify

        +
        +
        • +
      • +
        password: string
        +
        +

        the password to test against

        +
        +
        • +
      +

      Returns boolean

      +

      boolean

      +
      • +
    +
    +
    + +

    Static load

    + +
      +
    • + +
      +
      +

      Factory method to load the algorithms from the system

      +
      +
      +

      Returns HashingStrategy

      +

      a Hashing Strategy capable of hashing using the available algorithms

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/auth-common/classes/keystoreoptions.html b/docs/@vertx/auth-common/classes/keystoreoptions.html index f00c88aed..1e9f95cbd 100644 --- a/docs/@vertx/auth-common/classes/keystoreoptions.html +++ b/docs/@vertx/auth-common/classes/keystoreoptions.html @@ -77,47 +77,181 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    password

    -
    password: string
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    path

    -
    path: string
    - +
    +
    +

    Methods

    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    type

    -
    type: string
    - +
    + +

    getPath

    +
      +
    • getPath(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getType

    +
      +
    • getType(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        password: string
        +
        • +
      +

      Returns KeyStoreOptions

      +
      • +
    +
    +
    + +

    setPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        path: string
        +
        • +
      +

      Returns KeyStoreOptions

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      +

      Returns KeyStoreOptions

      +
      • +
    @@ -131,25 +265,46 @@

    type

    diff --git a/docs/@vertx/auth-common/classes/pubseckeyoptions.html b/docs/@vertx/auth-common/classes/pubseckeyoptions.html index 7d1ca1479..dca48c910 100644 --- a/docs/@vertx/auth-common/classes/pubseckeyoptions.html +++ b/docs/@vertx/auth-common/classes/pubseckeyoptions.html @@ -77,69 +77,265 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    algorithm

    -
    algorithm: string
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    certificate

    -
    certificate: boolean
    - +
    +
    +

    Methods

    +
    + +

    getAlgorithm

    +
      +
    • getAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    publicKey

    -
    publicKey: string
    - +
    + +

    getPublicKey

    +
      +
    • getPublicKey(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    secretKey

    -
    secretKey: string
    - +
    + +

    getSecretKey

    +
      +
    • getSecretKey(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    symmetric

    -
    symmetric: boolean
    - +
    + +

    isCertificate

    +
      +
    • isCertificate(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSymmetric

    +
      +
    • isSymmetric(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAlgorithm

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        algorithm: string
        +
        • +
      +

      Returns PubSecKeyOptions

      +
      • +
    +
    +
    + +

    setCertificate

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        certificate: boolean
        +
        • +
      +

      Returns PubSecKeyOptions

      +
      • +
    +
    +
    + +

    setPublicKey

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        publicKey: string
        +
        • +
      +

      Returns PubSecKeyOptions

      +
      • +
    +
    +
    + +

    setSecretKey

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        secretKey: string
        +
        • +
      +

      Returns PubSecKeyOptions

      +
      • +
    +
    +
    + +

    setSymmetric

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        symmetric: boolean
        +
        • +
      +

      Returns PubSecKeyOptions

      +
      • +
    @@ -153,12 +349,21 @@

    symmetric

    diff --git a/docs/@vertx/auth-common/classes/secretoptions.html b/docs/@vertx/auth-common/classes/secretoptions.html index 179ae600f..d574260a6 100644 --- a/docs/@vertx/auth-common/classes/secretoptions.html +++ b/docs/@vertx/auth-common/classes/secretoptions.html @@ -77,36 +77,139 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    secret

    -
    secret: string
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    type

    -
    type: string
    - +
    +
    +

    Methods

    +
    + +

    getSecret

    +
      +
    • getSecret(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getType

    +
      +
    • getType(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    setSecret

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        secret: string
        +
        • +
      +

      Returns SecretOptions

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      +

      Returns SecretOptions

      +
      • +
    @@ -120,12 +223,21 @@

    type

    diff --git a/docs/@vertx/auth-common/classes/user.html b/docs/@vertx/auth-common/classes/user.html index d2a1614f1..68c1979f4 100644 --- a/docs/@vertx/auth-common/classes/user.html +++ b/docs/@vertx/auth-common/classes/user.html @@ -101,12 +101,12 @@

    clearCache

  • -

    The User object will cache any authorities that it knows it has to avoid hitting the +

    The User object will cache any authorities that it knows it has to avoid hitting the underlying auth provider each time. Use this method if you want to clear this cache.

    @@ -125,7 +125,7 @@

    isAuthorised

  • @@ -145,17 +145,20 @@
    resultHandler: function
      • -
      • (result: AsyncResult<boolean>): void
        • +
      • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>

      • Parameters

        • -
          result: AsyncResult<boolean>
          +
          res: AsyncResult<boolean>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<boolean>> +

      • @@ -176,12 +179,12 @@

      isAuthorized

    • -

      Is the user authorised to

      +

      Is the user authorised to

      Parameters

      @@ -203,17 +206,20 @@
      resultHandler: function
        • -
        • (result: AsyncResult<boolean>): void
          • +
        • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>

        • Parameters

          • -
            result: AsyncResult<boolean>
            +
            res: AsyncResult<boolean>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<boolean>> +

        • @@ -235,12 +241,12 @@

        principal

      • -

        Get the underlying principal for the User. What this actually returns depends on the implementation. +

        Get the underlying principal for the User. What this actually returns depends on the implementation. For a simple user/password based auth, it's likely to contain a JSON object with the following structure: 

            {
@@ -251,6 +257,11 @@ 
        principal

        Returns object

        JSON representation of the Principal

        +
          +
        • +
          [key: string]: any
          +
          • +
    • @@ -264,12 +275,12 @@

    setAuthProvider

  • -

    Set the auth provider for the User. This is typically used to reattach a detached User with an AuthProvider, e.g. +

    Set the auth provider for the User. This is typically used to reattach a detached User with an AuthProvider, e.g. after it has been deserialized.

    @@ -298,12 +309,21 @@

    Returns void diff --git a/docs/@vertx/auth-common/classes/vertxcontextprng.html b/docs/@vertx/auth-common/classes/vertxcontextprng.html index da5228630..c5e7ada77 100644 --- a/docs/@vertx/auth-common/classes/vertxcontextprng.html +++ b/docs/@vertx/auth-common/classes/vertxcontextprng.html @@ -94,22 +94,46 @@

    Methods

    nextInt

    • nextInt(): number
      • +
    • nextInt(bound: number): number
    • -

      Returns a secure random int

      +

      Returns a secure random int

      Returns number

      random int.

      • +
    • + +
      +
      +

      Returns a secure random int, between 0 (inclusive) and the specified bound (exclusive).

      +
      +
      +

      Parameters

      +
        +
      • +
        bound: number
        +
        +

        the upper bound (exclusive), which must be positive.

        +
        +
        • +
      +

      Returns number

      +

      random int.

      +

    • @@ -122,12 +146,12 @@

    nextString

  • -

    Returns a Base64 mime encoded String of random data with the given length. The length parameter refers to the length +

    Returns a Base64 mime encoded String of random data with the given length. The length parameter refers to the length of the String before the encoding step.

    @@ -156,12 +180,12 @@

    Static current

  • -

    Get or create a secure non blocking random number generator using the current vert.x context. If there is no +

    Get or create a secure non blocking random number generator using the current vert.x context. If there is no current context (i.e.: not running on the eventloop) then a {@link java.lang.IllegalStateException} is thrown.

    @@ -176,12 +200,12 @@

    Returns
    -

    Get or create a secure non blocking random number generator using the current vert.x instance. Since the context +

    Get or create a secure non blocking random number generator using the current vert.x instance. Since the context might be different this method will attempt to use the current context first if available and then fall back to create a new instance of the PRNG.

    @@ -212,12 +236,21 @@

    Returns

    diff --git a/docs/@vertx/auth-common/globals.html b/docs/@vertx/auth-common/globals.html index c14422b3b..640a51da4 100644 --- a/docs/@vertx/auth-common/globals.html +++ b/docs/@vertx/auth-common/globals.html @@ -68,8 +68,11 @@

    Index

    Classes

    -
    -

    Interfaces

    - -
    • @@ -97,12 +94,21 @@

    Interfaces

    diff --git a/docs/@vertx/auth-common/index.html b/docs/@vertx/auth-common/index.html index 05785d1d3..70a7ce433 100644 --- a/docs/@vertx/auth-common/index.html +++ b/docs/@vertx/auth-common/index.html @@ -107,12 +107,21 @@ diff --git a/docs/@vertx/auth-digest/classes/htdigestauth.html b/docs/@vertx/auth-digest/classes/htdigestauth.html index 3dcda9761..69c46f9c0 100644 --- a/docs/@vertx/auth-digest/classes/htdigestauth.html +++ b/docs/@vertx/auth-digest/classes/htdigestauth.html @@ -68,7 +68,12 @@

    Class HtdigestAuth

    Hierarchy

    • - HtdigestAuth + any +
        +
      • + HtdigestAuth +
        • +
    @@ -98,12 +103,12 @@

    realm

  • -

    Return the currently used realm

    +

    Return the currently used realm

    Returns string

    @@ -122,12 +127,12 @@

    Static create

  • -

    Creates an instance of HtdigestAuth.

    +

    Creates an instance of HtdigestAuth.

    Parameters

    @@ -142,12 +147,12 @@

    Returns
    -

    Creates an instance of HtdigestAuth by using the given htfile file.

    +

    Creates an instance of HtdigestAuth by using the given htfile file.

    Parameters

    diff --git a/docs/@vertx/auth-htpasswd/assets/js/search.js b/docs/@vertx/auth-htpasswd/assets/js/search.js index 24845b01f..9df331983 100644 --- a/docs/@vertx/auth-htpasswd/assets/js/search.js +++ b/docs/@vertx/auth-htpasswd/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"HtpasswdAuthOptions","url":"classes/htpasswdauthoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"htpasswdFile","url":"classes/htpasswdauthoptions.html#htpasswdfile","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":2,"kind":1024,"name":"plainTextEnabled","url":"classes/htpasswdauthoptions.html#plaintextenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":3,"kind":128,"name":"HtpasswdAuth","url":"classes/htpasswdauth.html","classes":"tsd-kind-class"},{"id":4,"kind":2048,"name":"create","url":"classes/htpasswdauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HtpasswdAuth"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"HtpasswdAuthOptions","url":"classes/htpasswdauthoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/htpasswdauthoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":2,"kind":2048,"name":"getHtpasswdFile","url":"classes/htpasswdauthoptions.html#gethtpasswdfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":3,"kind":2048,"name":"setHtpasswdFile","url":"classes/htpasswdauthoptions.html#sethtpasswdfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":4,"kind":2048,"name":"isPlainTextEnabled","url":"classes/htpasswdauthoptions.html#isplaintextenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":5,"kind":2048,"name":"setPlainTextEnabled","url":"classes/htpasswdauthoptions.html#setplaintextenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HtpasswdAuthOptions"},{"id":6,"kind":128,"name":"HtpasswdAuth","url":"classes/htpasswdauth.html","classes":"tsd-kind-class"},{"id":7,"kind":2048,"name":"create","url":"classes/htpasswdauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HtpasswdAuth"}]}; \ No newline at end of file diff --git a/docs/@vertx/auth-htpasswd/classes/htpasswdauth.html b/docs/@vertx/auth-htpasswd/classes/htpasswdauth.html index 6f6d301e1..cf036a102 100644 --- a/docs/@vertx/auth-htpasswd/classes/htpasswdauth.html +++ b/docs/@vertx/auth-htpasswd/classes/htpasswdauth.html @@ -68,7 +68,12 @@

    Class HtpasswdAuth

    Hierarchy

    • - HtpasswdAuth + any +
        +
      • + HtpasswdAuth +
        • +

    • diff --git a/docs/@vertx/auth-htpasswd/classes/htpasswdauthoptions.html b/docs/@vertx/auth-htpasswd/classes/htpasswdauthoptions.html index 157b34516..2691db94a 100644 --- a/docs/@vertx/auth-htpasswd/classes/htpasswdauthoptions.html +++ b/docs/@vertx/auth-htpasswd/classes/htpasswdauthoptions.html @@ -77,36 +77,139 @@

    Index

    -

    Properties

    +

    Constructors

     +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    htpasswdFile

    -
    htpasswdFile: string
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    plainTextEnabled

    -
    plainTextEnabled: boolean
    - +
    +
    +

    Methods

    +
    + +

    getHtpasswdFile

    +
      +
    • getHtpasswdFile(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    isPlainTextEnabled

    +
      +
    • isPlainTextEnabled(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setHtpasswdFile

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        htpasswdFile: string
        +
        • +
      +

      Returns HtpasswdAuthOptions

      +
      • +
    +
    +
    + +

    setPlainTextEnabled

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        plainTextEnabled: boolean
        +
        • +
      +

      Returns HtpasswdAuthOptions

      +
      • +
    @@ -128,11 +231,20 @@

    plainTextEnabled

  • HtpasswdAuthOptions
    • diff --git a/docs/@vertx/auth-jdbc/assets/js/search.js b/docs/@vertx/auth-jdbc/assets/js/search.js index e987a4a9b..2436bd5a8 100644 --- a/docs/@vertx/auth-jdbc/assets/js/search.js +++ b/docs/@vertx/auth-jdbc/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"JDBCAuth","url":"classes/jdbcauth.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"create","url":"classes/jdbcauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCAuth"},{"id":2,"kind":2048,"name":"setAuthenticationQuery","url":"classes/jdbcauth.html#setauthenticationquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":3,"kind":2048,"name":"setRolesQuery","url":"classes/jdbcauth.html#setrolesquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":4,"kind":2048,"name":"setPermissionsQuery","url":"classes/jdbcauth.html#setpermissionsquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":5,"kind":2048,"name":"setRolePrefix","url":"classes/jdbcauth.html#setroleprefix","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":6,"kind":2048,"name":"computeHash","url":"classes/jdbcauth.html#computehash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":7,"kind":2048,"name":"generateSalt","url":"classes/jdbcauth.html#generatesalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":8,"kind":2048,"name":"setNonces","url":"classes/jdbcauth.html#setnonces","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":9,"kind":128,"name":"JDBCHashStrategy","url":"classes/jdbchashstrategy.html","classes":"tsd-kind-class"},{"id":10,"kind":2048,"name":"createSHA512","url":"classes/jdbchashstrategy.html#createsha512","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCHashStrategy"},{"id":11,"kind":2048,"name":"createPBKDF2","url":"classes/jdbchashstrategy.html#createpbkdf2","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCHashStrategy"},{"id":12,"kind":2048,"name":"generateSalt","url":"classes/jdbchashstrategy.html#generatesalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":13,"kind":2048,"name":"computeHash","url":"classes/jdbchashstrategy.html#computehash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":14,"kind":2048,"name":"getHashedStoredPwd","url":"classes/jdbchashstrategy.html#gethashedstoredpwd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":15,"kind":2048,"name":"getSalt","url":"classes/jdbchashstrategy.html#getsalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":16,"kind":2048,"name":"setNonces","url":"classes/jdbchashstrategy.html#setnonces","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":17,"kind":2048,"name":"isEqual","url":"classes/jdbchashstrategy.html#isequal","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCHashStrategy"},{"id":18,"kind":128,"name":"JDBCAuthOptions","url":"classes/jdbcauthoptions.html","classes":"tsd-kind-class"},{"id":19,"kind":1024,"name":"authenticationQuery","url":"classes/jdbcauthoptions.html#authenticationquery","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":20,"kind":1024,"name":"config","url":"classes/jdbcauthoptions.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":21,"kind":1024,"name":"datasourceName","url":"classes/jdbcauthoptions.html#datasourcename","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":22,"kind":1024,"name":"permissionsQuery","url":"classes/jdbcauthoptions.html#permissionsquery","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":23,"kind":1024,"name":"rolesPrefix","url":"classes/jdbcauthoptions.html#rolesprefix","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":24,"kind":1024,"name":"rolesQuery","url":"classes/jdbcauthoptions.html#rolesquery","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":25,"kind":1024,"name":"shared","url":"classes/jdbcauthoptions.html#shared","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JDBCAuthOptions"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"JDBCAuth","url":"classes/jdbcauth.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"create","url":"classes/jdbcauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCAuth"},{"id":2,"kind":2048,"name":"setAuthenticationQuery","url":"classes/jdbcauth.html#setauthenticationquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":3,"kind":2048,"name":"setRolesQuery","url":"classes/jdbcauth.html#setrolesquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":4,"kind":2048,"name":"setPermissionsQuery","url":"classes/jdbcauth.html#setpermissionsquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":5,"kind":2048,"name":"setRolePrefix","url":"classes/jdbcauth.html#setroleprefix","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":6,"kind":2048,"name":"computeHash","url":"classes/jdbcauth.html#computehash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":7,"kind":2048,"name":"generateSalt","url":"classes/jdbcauth.html#generatesalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":8,"kind":2048,"name":"setNonces","url":"classes/jdbcauth.html#setnonces","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuth"},{"id":9,"kind":128,"name":"JDBCHashStrategy","url":"classes/jdbchashstrategy.html","classes":"tsd-kind-class"},{"id":10,"kind":2048,"name":"createSHA512","url":"classes/jdbchashstrategy.html#createsha512","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCHashStrategy"},{"id":11,"kind":2048,"name":"createPBKDF2","url":"classes/jdbchashstrategy.html#createpbkdf2","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCHashStrategy"},{"id":12,"kind":2048,"name":"generateSalt","url":"classes/jdbchashstrategy.html#generatesalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":13,"kind":2048,"name":"computeHash","url":"classes/jdbchashstrategy.html#computehash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":14,"kind":2048,"name":"getHashedStoredPwd","url":"classes/jdbchashstrategy.html#gethashedstoredpwd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":15,"kind":2048,"name":"getSalt","url":"classes/jdbchashstrategy.html#getsalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":16,"kind":2048,"name":"setNonces","url":"classes/jdbchashstrategy.html#setnonces","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCHashStrategy"},{"id":17,"kind":2048,"name":"isEqual","url":"classes/jdbchashstrategy.html#isequal","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCHashStrategy"},{"id":18,"kind":128,"name":"JDBCAuthOptions","url":"classes/jdbcauthoptions.html","classes":"tsd-kind-class"},{"id":19,"kind":512,"name":"constructor","url":"classes/jdbcauthoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":20,"kind":2048,"name":"getAuthenticationQuery","url":"classes/jdbcauthoptions.html#getauthenticationquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":21,"kind":2048,"name":"setAuthenticationQuery","url":"classes/jdbcauthoptions.html#setauthenticationquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":22,"kind":2048,"name":"getConfig","url":"classes/jdbcauthoptions.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":23,"kind":2048,"name":"setConfig","url":"classes/jdbcauthoptions.html#setconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":24,"kind":2048,"name":"getDatasourceName","url":"classes/jdbcauthoptions.html#getdatasourcename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":25,"kind":2048,"name":"setDatasourceName","url":"classes/jdbcauthoptions.html#setdatasourcename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":26,"kind":2048,"name":"getPermissionsQuery","url":"classes/jdbcauthoptions.html#getpermissionsquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":27,"kind":2048,"name":"setPermissionsQuery","url":"classes/jdbcauthoptions.html#setpermissionsquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":28,"kind":2048,"name":"getRolesPrefix","url":"classes/jdbcauthoptions.html#getrolesprefix","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":29,"kind":2048,"name":"setRolesPrefix","url":"classes/jdbcauthoptions.html#setrolesprefix","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":30,"kind":2048,"name":"getRolesQuery","url":"classes/jdbcauthoptions.html#getrolesquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":31,"kind":2048,"name":"setRolesQuery","url":"classes/jdbcauthoptions.html#setrolesquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":32,"kind":2048,"name":"isShared","url":"classes/jdbcauthoptions.html#isshared","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"},{"id":33,"kind":2048,"name":"setShared","url":"classes/jdbcauthoptions.html#setshared","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JDBCAuthOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/auth-jdbc/classes/jdbcauth.html b/docs/@vertx/auth-jdbc/classes/jdbcauth.html index 4bfc3af0e..ce8cd5148 100644 --- a/docs/@vertx/auth-jdbc/classes/jdbcauth.html +++ b/docs/@vertx/auth-jdbc/classes/jdbcauth.html @@ -68,7 +68,12 @@

    Class JDBCAuth

    Hierarchy

    • - JDBCAuth + any +
        +
      • + JDBCAuth +
        • +
    @@ -105,12 +110,12 @@

    computeHash

  • -

    Compute the hashed password given the unhashed password and the salt without nonce

    +

    Compute the hashed password given the unhashed password and the salt without nonce

    The implementation relays to the JDBCHashStrategy provided.

    @@ -135,12 +140,12 @@

    Returns string
    -

    Compute the hashed password given the unhashed password and the salt

    +

    Compute the hashed password given the unhashed password and the salt

    The implementation relays to the JDBCHashStrategy provided.

    @@ -180,12 +185,12 @@

    generateSalt

  • -

    Compute a salt string.

    +

    Compute a salt string.

    The implementation relays to the JDBCHashStrategy provided.

    @@ -204,12 +209,12 @@

    setAuthenticationQuery

  • -

    Set the authentication query to use. Use this if you want to override the default authentication query.

    +

    Set the authentication query to use. Use this if you want to override the default authentication query.

    Parameters

    @@ -236,12 +241,12 @@

    setNonces

  • -

    Provide a application configuration level on hash nonce's as a ordered list of +

    Provide a application configuration level on hash nonce's as a ordered list of nonces where each position corresponds to a version.

    The nonces are supposed not to be stored in the underlying jdbc storage but to @@ -275,12 +280,12 @@

    setPermissionsQuery

  • -

    Set the permissions query to use. Use this if you want to override the default permissions query.

    +

    Set the permissions query to use. Use this if you want to override the default permissions query.

    Parameters

    @@ -307,12 +312,12 @@

    setRolePrefix

  • -

    Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    +

    Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    Parameters

    @@ -339,12 +344,12 @@

    setRolesQuery

  • -

    Set the roles query to use. Use this if you want to override the default roles query.

    +

    Set the roles query to use. Use this if you want to override the default roles query.

    Parameters

    @@ -371,12 +376,12 @@

    Static create

  • -

    Create a JDBC auth provider implementation

    +

    Create a JDBC auth provider implementation

    Parameters

    diff --git a/docs/@vertx/auth-jdbc/classes/jdbcauthoptions.html b/docs/@vertx/auth-jdbc/classes/jdbcauthoptions.html index c5f4f8c37..8730fd6f9 100644 --- a/docs/@vertx/auth-jdbc/classes/jdbcauthoptions.html +++ b/docs/@vertx/auth-jdbc/classes/jdbcauthoptions.html @@ -77,181 +77,461 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +

    • -

    Properties

    -
    - -

    authenticationQuery

    -
    authenticationQuery: string
    - -
    -
    -

    Set the authentication query to use. Use this if you want to override the default authentication query.

    -
    -
    -
    param
    -

    the authentication query

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    config

    -
    config: object
    - -
    -
    -

    The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

    -
    -
    -
    param
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAuthenticationQuery

    +
      +
    • getAuthenticationQuery(): string
      • +
    +
      +
    • + +
      +
      +

      Set the authentication query to use. Use this if you want to override the default authentication query.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    datasourceName

    -
    datasourceName: string
    - -
    -
    -

    Set the data source name to use, only use in shared mode.

    -
    -
    -
    param
    -

    the data source name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getConfig

    +
      +
    • getConfig(): object
      • +
    +
      +
    • + +
      +
      +

      The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

      +
      +
      +

      Returns object

      +

      a reference to this, so the API can be used fluently

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    permissionsQuery

    -
    permissionsQuery: string
    - -
    -
    -

    Set the permissions query to use. Use this if you want to override the default permissions query.

    -
    -
    -
    param
    -

    the permissions query

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDatasourceName

    +
      +
    • getDatasourceName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the data source name to use, only use in shared mode.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    rolesPrefix

    -
    rolesPrefix: string
    - -
    -
    -

    Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    -
    -
    -
    param
    -

    roles prefix

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPermissionsQuery

    +
      +
    • getPermissionsQuery(): string
      • +
    +
      +
    • + +
      +
      +

      Set the permissions query to use. Use this if you want to override the default permissions query.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    rolesQuery

    -
    rolesQuery: string
    - -
    -
    -

    Set the roles query to use. Use this if you want to override the default roles query.

    -
    -
    -
    param
    -

    the roles query

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getRolesPrefix

    +
      +
    • getRolesPrefix(): string
      • +
    +
      +
    • + +
      +
      +

      Set the role prefix to distinguish from permissions when checking for isPermitted requests.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    shared

    -
    shared: boolean
    - -
    -
    -

    Set whether the JDBC client is shared or non shared.

    -
    -
    -
    param
    -

    the sharing mode

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getRolesQuery

    +
      +
    • getRolesQuery(): string
      • +
    +
      +
    • + +
      +
      +

      Set the roles query to use. Use this if you want to override the default roles query.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isShared

    +
      +
    • isShared(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the JDBC client is shared or non shared.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAuthenticationQuery

    + +
      +
    • + +
      +
      +

      Set the authentication query to use. Use this if you want to override the default authentication query.

      +
      +
      +

      Parameters

      +
        +
      • +
        authenticationQuery: string
        +
        +

        the authentication query

        +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConfig

    + +
      +
    • + +
      +
      +

      The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        config: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDatasourceName

    + +
      +
    • + +
      +
      +

      Set the data source name to use, only use in shared mode.

      +
      +
      +

      Parameters

      +
        +
      • +
        datasourceName: string
        +
        +

        the data source name

        +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPermissionsQuery

    + +
      +
    • + +
      +
      +

      Set the permissions query to use. Use this if you want to override the default permissions query.

      +
      +
      +

      Parameters

      +
        +
      • +
        permissionsQuery: string
        +
        +

        the permissions query

        +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRolesPrefix

    + +
      +
    • + +
      +
      +

      Set the role prefix to distinguish from permissions when checking for isPermitted requests.

      +
      +
      +

      Parameters

      +
        +
      • +
        rolesPrefix: string
        +
        +

        roles prefix

        +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRolesQuery

    + +
      +
    • + +
      +
      +

      Set the roles query to use. Use this if you want to override the default roles query.

      +
      +
      +

      Parameters

      +
        +
      • +
        rolesQuery: string
        +
        +

        the roles query

        +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setShared

    + +
      +
    • + +
      +
      +

      Set whether the JDBC client is shared or non shared.

      +
      +
      +

      Parameters

      +
        +
      • +
        shared: boolean
        +
        +

        the sharing mode

        +
        +
        • +
      +

      Returns JDBCAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -273,26 +553,50 @@

    shared

  • JDBCAuthOptions
    • diff --git a/docs/@vertx/auth-jdbc/classes/jdbchashstrategy.html b/docs/@vertx/auth-jdbc/classes/jdbchashstrategy.html index d325fe10e..3ff99d77c 100644 --- a/docs/@vertx/auth-jdbc/classes/jdbchashstrategy.html +++ b/docs/@vertx/auth-jdbc/classes/jdbchashstrategy.html @@ -104,12 +104,12 @@

    computeHash

  • -

    Compute the hashed password given the unhashed password and the salt

    +

    Compute the hashed password given the unhashed password and the salt

    Parameters

    @@ -148,12 +148,12 @@

    generateSalt

  • -

    Compute a random salt.

    +

    Compute a random salt.

    Returns string

    @@ -171,12 +171,12 @@

    getHashedStoredPwd

  • -

    Retrieve the hashed password from the result of the authentication query

    +

    Retrieve the hashed password from the result of the authentication query

    Parameters

    @@ -203,12 +203,12 @@

    getSalt

  • -

    Retrieve the salt from the result of the authentication query

    +

    Retrieve the salt from the result of the authentication query

    Parameters

    @@ -235,12 +235,12 @@

    setNonces

  • -

    Sets a ordered list of nonces where each position corresponds to a version.

    +

    Sets a ordered list of nonces where each position corresponds to a version.

    The nonces are supposed not to be stored in the underlying jdbc storage but to be provided as a application configuration. The idea is to add one extra variable @@ -274,12 +274,12 @@

    Static createPBKDF2

  • -

    Implements a Hashing Strategy as per https://www.owasp.org/index.php/Password_Storage_Cheat_Sheet (2018-01-17).

    +

    Implements a Hashing Strategy as per https://www.owasp.org/index.php/Password_Storage_Cheat_Sheet (2018-01-17).

    New deployments should use this strategy instead of the default one (which was the previous OWASP recommendation).

    The work factor can be updated by using the nonces json array.

    @@ -308,12 +308,12 @@

    Static createSHA512

  • -

    This is the current backwards compatible hashing implementation, new applications should prefer the +

    This is the current backwards compatible hashing implementation, new applications should prefer the PBKDF2 implementation, unless the tradeoff between security and CPU usage is an option.

    @@ -341,12 +341,12 @@

    Static isEqual

  • -

    Time constant string comparision to avoid timming attacks.

    +

    Time constant string comparision to avoid timming attacks.

    Parameters

    diff --git a/docs/@vertx/auth-jwt/assets/js/search.js b/docs/@vertx/auth-jwt/assets/js/search.js index 330f86518..8747cfe2a 100644 --- a/docs/@vertx/auth-jwt/assets/js/search.js +++ b/docs/@vertx/auth-jwt/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"JWTAuthOptions","url":"classes/jwtauthoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"jwtOptions","url":"classes/jwtauthoptions.html#jwtoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":2,"kind":1024,"name":"keyStore","url":"classes/jwtauthoptions.html#keystore","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":3,"kind":1024,"name":"permissionsClaimKey","url":"classes/jwtauthoptions.html#permissionsclaimkey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":4,"kind":1024,"name":"pubSecKeys","url":"classes/jwtauthoptions.html#pubseckeys","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":5,"kind":1024,"name":"secrets","url":"classes/jwtauthoptions.html#secrets","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":6,"kind":128,"name":"JWTKeyStoreOptions","url":"classes/jwtkeystoreoptions.html","classes":"tsd-kind-class"},{"id":7,"kind":1024,"name":"password","url":"classes/jwtkeystoreoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":8,"kind":1024,"name":"path","url":"classes/jwtkeystoreoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":9,"kind":1024,"name":"type","url":"classes/jwtkeystoreoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":10,"kind":128,"name":"JWTOptions","url":"classes/jwtoptions.html","classes":"tsd-kind-class"},{"id":11,"kind":1024,"name":"algorithm","url":"classes/jwtoptions.html#algorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":12,"kind":1024,"name":"audience","url":"classes/jwtoptions.html#audience","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":13,"kind":1024,"name":"audiences","url":"classes/jwtoptions.html#audiences","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":14,"kind":1024,"name":"expiresInMinutes","url":"classes/jwtoptions.html#expiresinminutes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":15,"kind":1024,"name":"expiresInSeconds","url":"classes/jwtoptions.html#expiresinseconds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":16,"kind":1024,"name":"header","url":"classes/jwtoptions.html#header","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":17,"kind":1024,"name":"ignoreExpiration","url":"classes/jwtoptions.html#ignoreexpiration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":18,"kind":1024,"name":"issuer","url":"classes/jwtoptions.html#issuer","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":19,"kind":1024,"name":"leeway","url":"classes/jwtoptions.html#leeway","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":20,"kind":1024,"name":"noTimestamp","url":"classes/jwtoptions.html#notimestamp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":21,"kind":1024,"name":"permissions","url":"classes/jwtoptions.html#permissions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":22,"kind":1024,"name":"subject","url":"classes/jwtoptions.html#subject","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JWTOptions"},{"id":23,"kind":128,"name":"JWTAuth","url":"classes/jwtauth.html","classes":"tsd-kind-class"},{"id":24,"kind":2048,"name":"create","url":"classes/jwtauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JWTAuth"},{"id":25,"kind":2048,"name":"generateToken","url":"classes/jwtauth.html#generatetoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuth"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"JWTAuthOptions","url":"classes/jwtauthoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/jwtauthoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":2,"kind":2048,"name":"getJwks","url":"classes/jwtauthoptions.html#getjwks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":3,"kind":2048,"name":"setJwks","url":"classes/jwtauthoptions.html#setjwks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":4,"kind":2048,"name":"addJwk","url":"classes/jwtauthoptions.html#addjwk","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":5,"kind":2048,"name":"getJWTOptions","url":"classes/jwtauthoptions.html#getjwtoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":6,"kind":2048,"name":"setJWTOptions","url":"classes/jwtauthoptions.html#setjwtoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":7,"kind":2048,"name":"getKeyStore","url":"classes/jwtauthoptions.html#getkeystore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":8,"kind":2048,"name":"setKeyStore","url":"classes/jwtauthoptions.html#setkeystore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":9,"kind":2048,"name":"getPermissionsClaimKey","url":"classes/jwtauthoptions.html#getpermissionsclaimkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":10,"kind":2048,"name":"setPermissionsClaimKey","url":"classes/jwtauthoptions.html#setpermissionsclaimkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":11,"kind":2048,"name":"getPubSecKeys","url":"classes/jwtauthoptions.html#getpubseckeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":12,"kind":2048,"name":"setPubSecKeys","url":"classes/jwtauthoptions.html#setpubseckeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":13,"kind":2048,"name":"addPubSecKey","url":"classes/jwtauthoptions.html#addpubseckey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":14,"kind":2048,"name":"getSecrets","url":"classes/jwtauthoptions.html#getsecrets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":15,"kind":2048,"name":"setSecrets","url":"classes/jwtauthoptions.html#setsecrets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":16,"kind":2048,"name":"addSecret","url":"classes/jwtauthoptions.html#addsecret","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuthOptions"},{"id":17,"kind":128,"name":"JWTKeyStoreOptions","url":"classes/jwtkeystoreoptions.html","classes":"tsd-kind-class"},{"id":18,"kind":512,"name":"constructor","url":"classes/jwtkeystoreoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":19,"kind":2048,"name":"getPassword","url":"classes/jwtkeystoreoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":20,"kind":2048,"name":"setPassword","url":"classes/jwtkeystoreoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":21,"kind":2048,"name":"getPath","url":"classes/jwtkeystoreoptions.html#getpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":22,"kind":2048,"name":"setPath","url":"classes/jwtkeystoreoptions.html#setpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":23,"kind":2048,"name":"getType","url":"classes/jwtkeystoreoptions.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":24,"kind":2048,"name":"setType","url":"classes/jwtkeystoreoptions.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTKeyStoreOptions"},{"id":25,"kind":128,"name":"JWTOptions","url":"classes/jwtoptions.html","classes":"tsd-kind-class"},{"id":26,"kind":512,"name":"constructor","url":"classes/jwtoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JWTOptions"},{"id":27,"kind":2048,"name":"getAlgorithm","url":"classes/jwtoptions.html#getalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":28,"kind":2048,"name":"setAlgorithm","url":"classes/jwtoptions.html#setalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":29,"kind":2048,"name":"getAudience","url":"classes/jwtoptions.html#getaudience","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":30,"kind":2048,"name":"setAudience","url":"classes/jwtoptions.html#setaudience","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":31,"kind":2048,"name":"audiences","url":"classes/jwtoptions.html#audiences","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":32,"kind":2048,"name":"addAudience","url":"classes/jwtoptions.html#addaudience","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":33,"kind":2048,"name":"expiresInMinutes","url":"classes/jwtoptions.html#expiresinminutes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":34,"kind":2048,"name":"setExpiresInMinutes","url":"classes/jwtoptions.html#setexpiresinminutes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":35,"kind":2048,"name":"getExpiresInSeconds","url":"classes/jwtoptions.html#getexpiresinseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":36,"kind":2048,"name":"setExpiresInSeconds","url":"classes/jwtoptions.html#setexpiresinseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":37,"kind":2048,"name":"getHeader","url":"classes/jwtoptions.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":38,"kind":2048,"name":"setHeader","url":"classes/jwtoptions.html#setheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":39,"kind":2048,"name":"isIgnoreExpiration","url":"classes/jwtoptions.html#isignoreexpiration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":40,"kind":2048,"name":"setIgnoreExpiration","url":"classes/jwtoptions.html#setignoreexpiration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":41,"kind":2048,"name":"getIssuer","url":"classes/jwtoptions.html#getissuer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":42,"kind":2048,"name":"setIssuer","url":"classes/jwtoptions.html#setissuer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":43,"kind":2048,"name":"getLeeway","url":"classes/jwtoptions.html#getleeway","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":44,"kind":2048,"name":"setLeeway","url":"classes/jwtoptions.html#setleeway","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":45,"kind":2048,"name":"isNoTimestamp","url":"classes/jwtoptions.html#isnotimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":46,"kind":2048,"name":"setNoTimestamp","url":"classes/jwtoptions.html#setnotimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":47,"kind":2048,"name":"getPermissions","url":"classes/jwtoptions.html#getpermissions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":48,"kind":2048,"name":"setPermissions","url":"classes/jwtoptions.html#setpermissions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":49,"kind":2048,"name":"addPermission","url":"classes/jwtoptions.html#addpermission","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":50,"kind":2048,"name":"getSubject","url":"classes/jwtoptions.html#getsubject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":51,"kind":2048,"name":"setSubject","url":"classes/jwtoptions.html#setsubject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":52,"kind":128,"name":"JWTAuth","url":"classes/jwtauth.html","classes":"tsd-kind-class"},{"id":53,"kind":2048,"name":"create","url":"classes/jwtauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JWTAuth"},{"id":54,"kind":2048,"name":"generateToken","url":"classes/jwtauth.html#generatetoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTAuth"}]}; \ No newline at end of file diff --git a/docs/@vertx/auth-jwt/classes/jwtauth.html b/docs/@vertx/auth-jwt/classes/jwtauth.html index e9fec97fb..3e74822a3 100644 --- a/docs/@vertx/auth-jwt/classes/jwtauth.html +++ b/docs/@vertx/auth-jwt/classes/jwtauth.html @@ -68,7 +68,12 @@

    Class JWTAuth

    Hierarchy

    • - JWTAuth + any +
        +
      • + JWTAuth +
        • +
    • @@ -99,12 +104,12 @@

    generateToken

  • -

    Generate a new JWT token.

    +

    Generate a new JWT token.

    see
    @@ -119,6 +124,11 @@
    claims: object

    Json with user defined claims for a list of official claims

    +
      +
    • +
      [key: string]: any
      +
      • +
  • options: JWTOptions
    @@ -133,12 +143,12 @@

    Returns string
    -

    Generate a new JWT token.

    +

    Generate a new JWT token.

    see
    @@ -153,6 +163,11 @@
    claims: object

    Json with user defined claims for a list of official claims

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns string

    @@ -170,12 +185,12 @@

    Static create

  • -

    Create a JWT auth provider

    +

    Create a JWT auth provider

    Parameters

    diff --git a/docs/@vertx/auth-jwt/classes/jwtauthoptions.html b/docs/@vertx/auth-jwt/classes/jwtauthoptions.html index fc1a21c10..e1172ac6b 100644 --- a/docs/@vertx/auth-jwt/classes/jwtauthoptions.html +++ b/docs/@vertx/auth-jwt/classes/jwtauthoptions.html @@ -77,69 +77,394 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    - -

    jwtOptions

    -
    jwtOptions: JWTOptions
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    keyStore

    -
    keyStore: KeyStoreOptions
    - +
    +
    +

    Methods

    +
    + +

    addJwk

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        jwks: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    -
    - -

    permissionsClaimKey

    -
    permissionsClaimKey: string
    - +
    + +

    addPubSecKey

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pubSecKeys: PubSecKeyOptions
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    -
    - -

    pubSecKeys

    -
    pubSecKeys: PubSecKeyOptions
    - +
    + +

    addSecret

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        secrets: SecretOptions
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    -
    - -

    secrets

    -
    secrets: SecretOptions
    - +
    + +

    getJWTOptions

    + +
      +
    • + +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    getJwks

    +
      +
    • getJwks(): object
      • +
    +
      +
    • + +

      Returns object

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    getKeyStore

    +
      +
    • getKeyStore(): KeyStoreOptions
      • +
    +
      +
    • + +

      Returns KeyStoreOptions

      +
      • +
    +
    +
    + +

    getPermissionsClaimKey

    +
      +
    • getPermissionsClaimKey(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getPubSecKeys

    +
      +
    • getPubSecKeys(): PubSecKeyOptions
      • +
    +
      +
    • + +

      Returns PubSecKeyOptions

      +
      • +
    +
    +
    + +

    getSecrets

    +
      +
    • getSecrets(): SecretOptions
      • +
    +
      +
    • + +

      Returns SecretOptions

      +
      • +
    +
    +
    + +

    setJWTOptions

    + + +
    +
    + +

    setJwks

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        jwks: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    +
    +
    + +

    setKeyStore

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStore: KeyStoreOptions
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    +
    +
    + +

    setPermissionsClaimKey

    +
      +
    • setPermissionsClaimKey(permissionsClaimKey: string): JWTAuthOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        permissionsClaimKey: string
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    +
    +
    + +

    setPubSecKeys

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pubSecKeys: PubSecKeyOptions
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    +
    +
    + +

    setSecrets

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        secrets: SecretOptions
        +
        • +
      +

      Returns JWTAuthOptions

      +
      • +
    @@ -161,20 +486,53 @@

    secrets

  • JWTAuthOptions
    • diff --git a/docs/@vertx/auth-jwt/classes/jwtkeystoreoptions.html b/docs/@vertx/auth-jwt/classes/jwtkeystoreoptions.html index 78ff31bcf..4210a7541 100644 --- a/docs/@vertx/auth-jwt/classes/jwtkeystoreoptions.html +++ b/docs/@vertx/auth-jwt/classes/jwtkeystoreoptions.html @@ -77,47 +77,181 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    password

    -
    password: string
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    path

    -
    path: string
    - +
    +
    +

    Methods

    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    type

    -
    type: string
    - +
    + +

    getPath

    +
      +
    • getPath(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getType

    +
      +
    • getType(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        password: string
        +
        • +
      +

      Returns JWTKeyStoreOptions

      +
      • +
    +
    +
    + +

    setPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        path: string
        +
        • +
      +

      Returns JWTKeyStoreOptions

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      +

      Returns JWTKeyStoreOptions

      +
      • +
    @@ -142,14 +276,26 @@

    type

  • JWTKeyStoreOptions
    • diff --git a/docs/@vertx/auth-jwt/classes/jwtoptions.html b/docs/@vertx/auth-jwt/classes/jwtoptions.html index 8db06121a..40d0e4af1 100644 --- a/docs/@vertx/auth-jwt/classes/jwtoptions.html +++ b/docs/@vertx/auth-jwt/classes/jwtoptions.html @@ -77,146 +77,593 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    algorithm

    -
    algorithm: string
    - +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns JWTOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns JWTOptions

      +
      • +
    -
    - -

    audience

    -
    audience: string
    - +
    +
    +

    Methods

    +
    + +

    addAudience

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        audiences: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    -
    +
    + +

    addPermission

    +
      +
    • addPermission(permissions: string): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        permissions: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +

    audiences

    -
    audiences: string
    - +
      +
    • audiences(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    +

    expiresInMinutes

    -
    expiresInMinutes: number
    - +
      +
    • expiresInMinutes(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    expiresInSeconds

    -
    expiresInSeconds: number
    - +
    + +

    getAlgorithm

    +
      +
    • getAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    header

    -
    header: object
    - +
    + +

    getAudience

    +
      +
    • getAudience(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    ignoreExpiration

    -
    ignoreExpiration: boolean
    - +
    + +

    getExpiresInSeconds

    +
      +
    • getExpiresInSeconds(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    issuer

    -
    issuer: string
    - +
    + +

    getHeader

    +
      +
    • getHeader(): object
      • +
    +
      +
    • + +

      Returns object

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    leeway

    -
    leeway: number
    - +
    + +

    getIssuer

    +
      +
    • getIssuer(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    noTimestamp

    -
    noTimestamp: boolean
    - +
    + +

    getLeeway

    +
      +
    • getLeeway(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    permissions

    -
    permissions: string
    - +
    + +

    getPermissions

    +
      +
    • getPermissions(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    subject

    -
    subject: string
    - +
    + +

    getSubject

    +
      +
    • getSubject(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    isIgnoreExpiration

    +
      +
    • isIgnoreExpiration(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isNoTimestamp

    +
      +
    • isNoTimestamp(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAlgorithm

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        algorithm: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setAudience

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        audience: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setExpiresInMinutes

    +
      +
    • setExpiresInMinutes(expiresInMinutes: number): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        expiresInMinutes: number
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setExpiresInSeconds

    +
      +
    • setExpiresInSeconds(expiresInSeconds: number): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        expiresInSeconds: number
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setHeader

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        header: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setIgnoreExpiration

    +
      +
    • setIgnoreExpiration(ignoreExpiration: boolean): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        ignoreExpiration: boolean
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setIssuer

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        issuer: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setLeeway

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        leeway: number
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setNoTimestamp

    +
      +
    • setNoTimestamp(noTimestamp: boolean): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        noTimestamp: boolean
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setPermissions

    +
      +
    • setPermissions(permissions: string): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        permissions: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setSubject

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        subject: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    @@ -244,41 +691,83 @@

    subject

  • JWTOptions
    • diff --git a/docs/@vertx/auth-mongo/assets/js/search.js b/docs/@vertx/auth-mongo/assets/js/search.js index 9a1ed66e5..5cec78687 100644 --- a/docs/@vertx/auth-mongo/assets/js/search.js +++ b/docs/@vertx/auth-mongo/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"HashAlgorithm","url":"enums/hashalgorithm.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"SHA512","url":"enums/hashalgorithm.html#sha512","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashAlgorithm"},{"id":2,"kind":16,"name":"PBKDF2","url":"enums/hashalgorithm.html#pbkdf2","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashAlgorithm"},{"id":3,"kind":4,"name":"HashSaltStyle","url":"enums/hashsaltstyle.html","classes":"tsd-kind-enum"},{"id":4,"kind":16,"name":"NO_SALT","url":"enums/hashsaltstyle.html#no_salt","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashSaltStyle"},{"id":5,"kind":16,"name":"COLUMN","url":"enums/hashsaltstyle.html#column","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashSaltStyle"},{"id":6,"kind":16,"name":"EXTERNAL","url":"enums/hashsaltstyle.html#external","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashSaltStyle"},{"id":7,"kind":128,"name":"HashStrategy","url":"classes/hashstrategy.html","classes":"tsd-kind-class"},{"id":8,"kind":2048,"name":"computeHash","url":"classes/hashstrategy.html#computehash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":9,"kind":2048,"name":"getStoredPwd","url":"classes/hashstrategy.html#getstoredpwd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":10,"kind":2048,"name":"getSalt","url":"classes/hashstrategy.html#getsalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":11,"kind":2048,"name":"setExternalSalt","url":"classes/hashstrategy.html#setexternalsalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":12,"kind":2048,"name":"setSaltStyle","url":"classes/hashstrategy.html#setsaltstyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":13,"kind":2048,"name":"getSaltStyle","url":"classes/hashstrategy.html#getsaltstyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":14,"kind":2048,"name":"setAlgorithm","url":"classes/hashstrategy.html#setalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":15,"kind":128,"name":"MongoAuth","url":"classes/mongoauth.html","classes":"tsd-kind-class"},{"id":16,"kind":2048,"name":"create","url":"classes/mongoauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MongoAuth"},{"id":17,"kind":2048,"name":"setCollectionName","url":"classes/mongoauth.html#setcollectionname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":18,"kind":2048,"name":"setUsernameField","url":"classes/mongoauth.html#setusernamefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":19,"kind":2048,"name":"setPasswordField","url":"classes/mongoauth.html#setpasswordfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":20,"kind":2048,"name":"setRoleField","url":"classes/mongoauth.html#setrolefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":21,"kind":2048,"name":"setPermissionField","url":"classes/mongoauth.html#setpermissionfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":22,"kind":2048,"name":"setUsernameCredentialField","url":"classes/mongoauth.html#setusernamecredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":23,"kind":2048,"name":"setPasswordCredentialField","url":"classes/mongoauth.html#setpasswordcredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":24,"kind":2048,"name":"setSaltField","url":"classes/mongoauth.html#setsaltfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":25,"kind":2048,"name":"getCollectionName","url":"classes/mongoauth.html#getcollectionname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":26,"kind":2048,"name":"getUsernameField","url":"classes/mongoauth.html#getusernamefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":27,"kind":2048,"name":"getPasswordField","url":"classes/mongoauth.html#getpasswordfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":28,"kind":2048,"name":"getRoleField","url":"classes/mongoauth.html#getrolefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":29,"kind":2048,"name":"getPermissionField","url":"classes/mongoauth.html#getpermissionfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":30,"kind":2048,"name":"getUsernameCredentialField","url":"classes/mongoauth.html#getusernamecredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":31,"kind":2048,"name":"getPasswordCredentialField","url":"classes/mongoauth.html#getpasswordcredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":32,"kind":2048,"name":"getSaltField","url":"classes/mongoauth.html#getsaltfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":33,"kind":2048,"name":"setHashStrategy","url":"classes/mongoauth.html#sethashstrategy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":34,"kind":2048,"name":"getHashStrategy","url":"classes/mongoauth.html#gethashstrategy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":35,"kind":2048,"name":"setHashAlgorithm","url":"classes/mongoauth.html#sethashalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":36,"kind":2048,"name":"insertUser","url":"classes/mongoauth.html#insertuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":37,"kind":128,"name":"MongoAuthOptions","url":"classes/mongoauthoptions.html","classes":"tsd-kind-class"},{"id":38,"kind":1024,"name":"collectionName","url":"classes/mongoauthoptions.html#collectionname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":39,"kind":1024,"name":"config","url":"classes/mongoauthoptions.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":40,"kind":1024,"name":"datasourceName","url":"classes/mongoauthoptions.html#datasourcename","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":41,"kind":1024,"name":"passwordField","url":"classes/mongoauthoptions.html#passwordfield","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":42,"kind":1024,"name":"permissionField","url":"classes/mongoauthoptions.html#permissionfield","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":43,"kind":1024,"name":"roleField","url":"classes/mongoauthoptions.html#rolefield","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":44,"kind":1024,"name":"saltField","url":"classes/mongoauthoptions.html#saltfield","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":45,"kind":1024,"name":"saltStyle","url":"classes/mongoauthoptions.html#saltstyle","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":46,"kind":1024,"name":"shared","url":"classes/mongoauthoptions.html#shared","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":47,"kind":1024,"name":"usernameCredentialField","url":"classes/mongoauthoptions.html#usernamecredentialfield","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":48,"kind":1024,"name":"usernameField","url":"classes/mongoauthoptions.html#usernamefield","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MongoAuthOptions"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"HashAlgorithm","url":"enums/hashalgorithm.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"SHA512","url":"enums/hashalgorithm.html#sha512","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashAlgorithm"},{"id":2,"kind":16,"name":"PBKDF2","url":"enums/hashalgorithm.html#pbkdf2","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashAlgorithm"},{"id":3,"kind":4,"name":"HashSaltStyle","url":"enums/hashsaltstyle.html","classes":"tsd-kind-enum"},{"id":4,"kind":16,"name":"NO_SALT","url":"enums/hashsaltstyle.html#no_salt","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashSaltStyle"},{"id":5,"kind":16,"name":"COLUMN","url":"enums/hashsaltstyle.html#column","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashSaltStyle"},{"id":6,"kind":16,"name":"EXTERNAL","url":"enums/hashsaltstyle.html#external","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HashSaltStyle"},{"id":7,"kind":128,"name":"HashStrategy","url":"classes/hashstrategy.html","classes":"tsd-kind-class"},{"id":8,"kind":2048,"name":"computeHash","url":"classes/hashstrategy.html#computehash","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":9,"kind":2048,"name":"getStoredPwd","url":"classes/hashstrategy.html#getstoredpwd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":10,"kind":2048,"name":"getSalt","url":"classes/hashstrategy.html#getsalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":11,"kind":2048,"name":"setExternalSalt","url":"classes/hashstrategy.html#setexternalsalt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":12,"kind":2048,"name":"setSaltStyle","url":"classes/hashstrategy.html#setsaltstyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":13,"kind":2048,"name":"getSaltStyle","url":"classes/hashstrategy.html#getsaltstyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":14,"kind":2048,"name":"setAlgorithm","url":"classes/hashstrategy.html#setalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HashStrategy"},{"id":15,"kind":128,"name":"MongoAuth","url":"classes/mongoauth.html","classes":"tsd-kind-class"},{"id":16,"kind":2048,"name":"create","url":"classes/mongoauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MongoAuth"},{"id":17,"kind":2048,"name":"setCollectionName","url":"classes/mongoauth.html#setcollectionname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":18,"kind":2048,"name":"setUsernameField","url":"classes/mongoauth.html#setusernamefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":19,"kind":2048,"name":"setPasswordField","url":"classes/mongoauth.html#setpasswordfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":20,"kind":2048,"name":"setRoleField","url":"classes/mongoauth.html#setrolefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":21,"kind":2048,"name":"setPermissionField","url":"classes/mongoauth.html#setpermissionfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":22,"kind":2048,"name":"setUsernameCredentialField","url":"classes/mongoauth.html#setusernamecredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":23,"kind":2048,"name":"setPasswordCredentialField","url":"classes/mongoauth.html#setpasswordcredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":24,"kind":2048,"name":"setSaltField","url":"classes/mongoauth.html#setsaltfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":25,"kind":2048,"name":"getCollectionName","url":"classes/mongoauth.html#getcollectionname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":26,"kind":2048,"name":"getUsernameField","url":"classes/mongoauth.html#getusernamefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":27,"kind":2048,"name":"getPasswordField","url":"classes/mongoauth.html#getpasswordfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":28,"kind":2048,"name":"getRoleField","url":"classes/mongoauth.html#getrolefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":29,"kind":2048,"name":"getPermissionField","url":"classes/mongoauth.html#getpermissionfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":30,"kind":2048,"name":"getUsernameCredentialField","url":"classes/mongoauth.html#getusernamecredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":31,"kind":2048,"name":"getPasswordCredentialField","url":"classes/mongoauth.html#getpasswordcredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":32,"kind":2048,"name":"getSaltField","url":"classes/mongoauth.html#getsaltfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":33,"kind":2048,"name":"setHashStrategy","url":"classes/mongoauth.html#sethashstrategy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":34,"kind":2048,"name":"getHashStrategy","url":"classes/mongoauth.html#gethashstrategy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":35,"kind":2048,"name":"setHashAlgorithm","url":"classes/mongoauth.html#sethashalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":36,"kind":2048,"name":"insertUser","url":"classes/mongoauth.html#insertuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuth"},{"id":37,"kind":128,"name":"MongoAuthOptions","url":"classes/mongoauthoptions.html","classes":"tsd-kind-class"},{"id":38,"kind":512,"name":"constructor","url":"classes/mongoauthoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":39,"kind":2048,"name":"getCollectionName","url":"classes/mongoauthoptions.html#getcollectionname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":40,"kind":2048,"name":"setCollectionName","url":"classes/mongoauthoptions.html#setcollectionname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":41,"kind":2048,"name":"getConfig","url":"classes/mongoauthoptions.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":42,"kind":2048,"name":"setConfig","url":"classes/mongoauthoptions.html#setconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":43,"kind":2048,"name":"getDatasourceName","url":"classes/mongoauthoptions.html#getdatasourcename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":44,"kind":2048,"name":"setDatasourceName","url":"classes/mongoauthoptions.html#setdatasourcename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":45,"kind":2048,"name":"getPasswordField","url":"classes/mongoauthoptions.html#getpasswordfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":46,"kind":2048,"name":"setPasswordField","url":"classes/mongoauthoptions.html#setpasswordfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":47,"kind":2048,"name":"getPermissionField","url":"classes/mongoauthoptions.html#getpermissionfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":48,"kind":2048,"name":"setPermissionField","url":"classes/mongoauthoptions.html#setpermissionfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":49,"kind":2048,"name":"getRoleField","url":"classes/mongoauthoptions.html#getrolefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":50,"kind":2048,"name":"setRoleField","url":"classes/mongoauthoptions.html#setrolefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":51,"kind":2048,"name":"getSaltField","url":"classes/mongoauthoptions.html#getsaltfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":52,"kind":2048,"name":"setSaltField","url":"classes/mongoauthoptions.html#setsaltfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":53,"kind":2048,"name":"getSaltStyle","url":"classes/mongoauthoptions.html#getsaltstyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":54,"kind":2048,"name":"setSaltStyle","url":"classes/mongoauthoptions.html#setsaltstyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":55,"kind":2048,"name":"getShared","url":"classes/mongoauthoptions.html#getshared","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":56,"kind":2048,"name":"setShared","url":"classes/mongoauthoptions.html#setshared","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":57,"kind":2048,"name":"getUsernameCredentialField","url":"classes/mongoauthoptions.html#getusernamecredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":58,"kind":2048,"name":"setUsernameCredentialField","url":"classes/mongoauthoptions.html#setusernamecredentialfield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":59,"kind":2048,"name":"getUsernameField","url":"classes/mongoauthoptions.html#getusernamefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"},{"id":60,"kind":2048,"name":"setUsernameField","url":"classes/mongoauthoptions.html#setusernamefield","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MongoAuthOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/auth-mongo/classes/hashstrategy.html b/docs/@vertx/auth-mongo/classes/hashstrategy.html index adda80b2f..a639a68e4 100644 --- a/docs/@vertx/auth-mongo/classes/hashstrategy.html +++ b/docs/@vertx/auth-mongo/classes/hashstrategy.html @@ -103,12 +103,12 @@

    computeHash

  • -

    Compute the hashed password given the unhashed password and the user

    +

    Compute the hashed password given the unhashed password and the user

    Parameters

    @@ -142,12 +142,12 @@

    getSalt

  • -

    Retrieve the salt. The source of the salt can be the external salt or the propriate column of the given user, +

    Retrieve the salt. The source of the salt can be the external salt or the propriate column of the given user, depending on the defined HashSaltStyle

    @@ -179,12 +179,12 @@

    getSaltStyle

  • -

    Get the defined HashSaltStyle of the current instance

    +

    Get the defined HashSaltStyle of the current instance

    Returns HashSaltStyle

    @@ -202,12 +202,12 @@

    getStoredPwd

  • -

    Retrieve the password from the user, or as clear text or as hashed version, depending on the definition

    +

    Retrieve the password from the user, or as clear text or as hashed version, depending on the definition

    Parameters

    @@ -234,12 +234,12 @@

    setAlgorithm

  • -

    Allows the selection of the hashing algorithm.

    +

    Allows the selection of the hashing algorithm.

    Parameters

    @@ -265,12 +265,12 @@

    setExternalSalt

  • -

    Set an external salt. This method should be used in case of {@link HashSaltStyle#EXTERNAL}

    +

    Set an external salt. This method should be used in case of {@link HashSaltStyle#EXTERNAL}

    Parameters

    @@ -296,12 +296,12 @@

    setSaltStyle

  • -

    Set the saltstyle as defined by HashSaltStyle.

    +

    Set the saltstyle as defined by HashSaltStyle.

    Parameters

    diff --git a/docs/@vertx/auth-mongo/classes/mongoauth.html b/docs/@vertx/auth-mongo/classes/mongoauth.html index 749800037..3d5adf583 100644 --- a/docs/@vertx/auth-mongo/classes/mongoauth.html +++ b/docs/@vertx/auth-mongo/classes/mongoauth.html @@ -68,7 +68,12 @@

    Class MongoAuth

    Hierarchy

    • - MongoAuth + any +
        +
      • + MongoAuth +
        • +
    • @@ -117,12 +122,12 @@

    getCollectionName

  • -

    The name of the collection used to store User objects inside. Defaults to {@link #DEFAULT_COLLECTION_NAME}

    +

    The name of the collection used to store User objects inside. Defaults to {@link #DEFAULT_COLLECTION_NAME}

    Returns string

    @@ -140,12 +145,12 @@

    getHashStrategy

  • -

    The HashStrategy which is used by the current instance

    +

    The HashStrategy which is used by the current instance

    Returns HashStrategy

    @@ -163,12 +168,12 @@

    getPasswordCredentialField

  • -

    Get the name of the field to be used as property for the password of credentials in the method +

    Get the name of the field to be used as property for the password of credentials in the method {@link #authenticate(JsonObject, io.vertx.core.Handler)}. Defaults to {@link #DEFAULT_CREDENTIAL_PASSWORD_FIELD}

    @@ -187,12 +192,12 @@

    getPasswordField

  • -

    Get the name of the field to be used for the password Defaults to {@link #DEFAULT_PASSWORD_FIELD}

    +

    Get the name of the field to be used for the password Defaults to {@link #DEFAULT_PASSWORD_FIELD}

    Returns string

    @@ -210,12 +215,12 @@

    getPermissionField

  • -

    Get the name of the field to be used for the permissions. Defaults to {@link #DEFAULT_PERMISSION_FIELD}. +

    Get the name of the field to be used for the permissions. Defaults to {@link #DEFAULT_PERMISSION_FIELD}. Permissions are expected to be saved as JsonArray

    @@ -234,12 +239,12 @@

    getRoleField

  • -

    Get the name of the field to be used for the roles. Defaults to {@link #DEFAULT_ROLE_FIELD}. Roles are expected to +

    Get the name of the field to be used for the roles. Defaults to {@link #DEFAULT_ROLE_FIELD}. Roles are expected to be saved as JsonArray

    @@ -258,12 +263,12 @@

    getSaltField

  • -

    Get the name of the field to be used for the salt. Only used when {@link HashStrategy#setSaltStyle(HashSaltStyle)} is +

    Get the name of the field to be used for the salt. Only used when {@link HashStrategy#setSaltStyle(HashSaltStyle)} is set to {@link HashSaltStyle#COLUMN}

    @@ -282,12 +287,12 @@

    getUsernameCredentialField

  • -

    Get the name of the field to be used as property for the username in the method +

    Get the name of the field to be used as property for the username in the method {@link #authenticate(JsonObject, io.vertx.core.Handler)}. Defaults to {@link #DEFAULT_CREDENTIAL_USERNAME_FIELD}

    @@ -306,12 +311,12 @@

    getUsernameField

  • -

    Get the name of the field to be used for the username. Defaults to {@link #DEFAULT_USERNAME_FIELD}

    +

    Get the name of the field to be used for the username. Defaults to {@link #DEFAULT_USERNAME_FIELD}

    Returns string

    @@ -329,12 +334,12 @@

    insertUser

  • -

    Insert a new user into mongo in the convenient way

    +

    Insert a new user into mongo in the convenient way

    Parameters

    @@ -371,17 +376,20 @@
    resultHandler: function
      • -
      • (result: AsyncResult<string>): void
        • +
      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

      • Parameters

        • -
          result: AsyncResult<string>
          +
          res: AsyncResult<string>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<string>> +

      • @@ -402,12 +410,12 @@

      setCollectionName

    • -

      Set the name of the collection to be used. Defaults to {@link #DEFAULT_COLLECTION_NAME}

      +

      Set the name of the collection to be used. Defaults to {@link #DEFAULT_COLLECTION_NAME}

      Parameters

      @@ -434,12 +442,12 @@

      setHashAlgorithm

    • -

      The Hash Algorithm which is used by the current instance

      +

      The Hash Algorithm which is used by the current instance

      Parameters

      @@ -466,12 +474,12 @@

      setHashStrategy

    • -

      The HashStrategy which is used by the current instance

      +

      The HashStrategy which is used by the current instance

      Parameters

      @@ -498,12 +506,12 @@

      setPasswordCredentialField

    • -

      Set the name of the field to be used as property for the password of credentials in the method +

      Set the name of the field to be used as property for the password of credentials in the method {@link #authenticate(JsonObject, io.vertx.core.Handler)}. Defaults to {@link #DEFAULT_CREDENTIAL_PASSWORD_FIELD}

      @@ -531,12 +539,12 @@

      setPasswordField

    • -

      Set the name of the field to be used for the password Defaults to {@link #DEFAULT_PASSWORD_FIELD}

      +

      Set the name of the field to be used for the password Defaults to {@link #DEFAULT_PASSWORD_FIELD}

      Parameters

      @@ -563,12 +571,12 @@

      setPermissionField

    • -

      Set the name of the field to be used for the permissions. Defaults to {@link #DEFAULT_PERMISSION_FIELD}. +

      Set the name of the field to be used for the permissions. Defaults to {@link #DEFAULT_PERMISSION_FIELD}. Permissions are expected to be saved as JsonArray

      @@ -596,12 +604,12 @@

      setRoleField

    • -

      Set the name of the field to be used for the roles. Defaults to {@link #DEFAULT_ROLE_FIELD}. Roles are expected to +

      Set the name of the field to be used for the roles. Defaults to {@link #DEFAULT_ROLE_FIELD}. Roles are expected to be saved as JsonArray

      @@ -629,12 +637,12 @@

      setSaltField

    • -

      Set the name of the field to be used for the salt. Only used when {@link HashStrategy#setSaltStyle(HashSaltStyle)} is +

      Set the name of the field to be used for the salt. Only used when {@link HashStrategy#setSaltStyle(HashSaltStyle)} is set to {@link HashSaltStyle#COLUMN}

      @@ -662,12 +670,12 @@

      setUsernameCredentialField

    • -

      Set the name of the field to be used as property for the username in the method +

      Set the name of the field to be used as property for the username in the method {@link #authenticate(JsonObject, io.vertx.core.Handler)}. Defaults to {@link #DEFAULT_CREDENTIAL_USERNAME_FIELD}

      @@ -695,12 +703,12 @@

      setUsernameField

    • -

      Set the name of the field to be used for the username. Defaults to {@link #DEFAULT_USERNAME_FIELD}

      +

      Set the name of the field to be used for the username. Defaults to {@link #DEFAULT_USERNAME_FIELD}

      Parameters

      @@ -727,12 +735,12 @@

      Static create

    • -

      Creates an instance of MongoAuth by using the given {@link MongoClient} and configuration object. An example for a +

      Creates an instance of MongoAuth by using the given {@link MongoClient} and configuration object. An example for a configuration object:

      @@ -751,8 +759,13 @@ 
      mongoClient: MongoClient
      
 								
    • 
 									
      config: object
      
 									
      
-										
            the configuration object for the current instance. By this
      
+										
            the configuration object for the current instance. By this
      
 									
      
+									
        
+										
      • 
+											
        [key: string]: any
        
+										
        • 
+									
      
 								
      •

    Returns MongoAuth

    diff --git a/docs/@vertx/auth-mongo/classes/mongoauthoptions.html b/docs/@vertx/auth-mongo/classes/mongoauthoptions.html index e023fb7d5..3a925ed37 100644 --- a/docs/@vertx/auth-mongo/classes/mongoauthoptions.html +++ b/docs/@vertx/auth-mongo/classes/mongoauthoptions.html @@ -77,278 +77,692 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    - -

    collectionName

    -
    collectionName: string
    - -
    -
    -

    The property name to be used to set the name of the collection inside the config.

    -
    -
    -
    param
    -

    the collection name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    config

    -
    config: object
    - -
    -
    -

    The mongo client configuration: see Mongo Client documentation.

    -
    -
    -
    param
    -

    the mongo config

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getCollectionName

    +
      +
    • getCollectionName(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the collection inside the config.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    datasourceName

    -
    datasourceName: string
    - -
    -
    -

    The mongo data source name: see Mongo Client documentation.

    -
    -
    -
    param
    -

    the data source name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getConfig

    +
      +
    • getConfig(): object
      • +
    +
      +
    • + +
      +
      +

      The mongo client configuration: see Mongo Client documentation.

      +
      +
      +

      Returns object

      +

      a reference to this, so the API can be used fluently

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    passwordField

    -
    passwordField: string
    - -
    -
    -

    The property name to be used to set the name of the field, where the password is stored inside

    -
    -
    -
    param
    -

    the password field

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDatasourceName

    +
      +
    • getDatasourceName(): string
      • +
    +
      +
    • + +
      +
      +

      The mongo data source name: see Mongo Client documentation.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    permissionField

    -
    permissionField: string
    - -
    -
    -

    The property name to be used to set the name of the field, where the permissions are stored inside.

    -
    -
    -
    param
    -

    the permission field

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPasswordField

    +
      +
    • getPasswordField(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the password is stored inside

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    roleField

    -
    roleField: string
    - -
    -
    -

    The property name to be used to set the name of the field, where the roles are stored inside.

    -
    -
    -
    param
    -

    the role field

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPermissionField

    +
      +
    • getPermissionField(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the permissions are stored inside.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    saltField

    -
    saltField: string
    - -
    -
    -

    The property name to be used to set the name of the field, where the SALT is stored inside.

    -
    -
    -
    param
    -

    the salt field

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getRoleField

    +
      +
    • getRoleField(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the roles are stored inside.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    saltStyle

    -
    saltStyle: HashSaltStyle
    - -
    -
    -

    The property name to be used to set the name of the field, where the salt style is stored inside

    -
    -
    -
    param
    -

    the salt style

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getSaltField

    +
      +
    • getSaltField(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the SALT is stored inside.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    shared

    -
    shared: boolean
    - -
    -
    -

    Use a shared Mongo client or not.

    -
    -
    -
    param
    -

    true to use a shared client

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getSaltStyle

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the salt style is stored inside

      +
      +
      +

      Returns HashSaltStyle

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    usernameCredentialField

    -
    usernameCredentialField: string
    - -
    -
    -

    The property name to be used to set the name of the field, where the username for the credentials is stored inside.

    -
    -
    -
    param
    -

    the username credential field

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getShared

    +
      +
    • getShared(): boolean
      • +
    +
      +
    • + +
      +
      +

      Use a shared Mongo client or not.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    usernameField

    -
    usernameField: string
    - -
    -
    -

    The property name to be used to set the name of the field, where the username is stored inside.

    -
    -
    -
    param
    -

    the username field

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getUsernameCredentialField

    +
      +
    • getUsernameCredentialField(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the username for the credentials is stored inside.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getUsernameField

    +
      +
    • getUsernameField(): string
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the username is stored inside.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCollectionName

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the collection inside the config.

      +
      +
      +

      Parameters

      +
        +
      • +
        collectionName: string
        +
        +

        the collection name

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConfig

    + +
      +
    • + +
      +
      +

      The mongo client configuration: see Mongo Client documentation.

      +
      +
      +

      Parameters

      +
        +
      • +
        config: object
        +
        +

        the mongo config

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDatasourceName

    + +
      +
    • + +
      +
      +

      The mongo data source name: see Mongo Client documentation.

      +
      +
      +

      Parameters

      +
        +
      • +
        datasourceName: string
        +
        +

        the data source name

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPasswordField

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the password is stored inside

      +
      +
      +

      Parameters

      +
        +
      • +
        passwordField: string
        +
        +

        the password field

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPermissionField

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the permissions are stored inside.

      +
      +
      +

      Parameters

      +
        +
      • +
        permissionField: string
        +
        +

        the permission field

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRoleField

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the roles are stored inside.

      +
      +
      +

      Parameters

      +
        +
      • +
        roleField: string
        +
        +

        the role field

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSaltField

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the SALT is stored inside.

      +
      +
      +

      Parameters

      +
        +
      • +
        saltField: string
        +
        +

        the salt field

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSaltStyle

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the salt style is stored inside

      +
      +
      +

      Parameters

      + +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setShared

    + +
      +
    • + +
      +
      +

      Use a shared Mongo client or not.

      +
      +
      +

      Parameters

      +
        +
      • +
        shared: boolean
        +
        +

        true to use a shared client

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setUsernameCredentialField

    +
      +
    • setUsernameCredentialField(usernameCredentialField: string): MongoAuthOptions
      • +
    +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the username for the credentials is stored inside.

      +
      +
      +

      Parameters

      +
        +
      • +
        usernameCredentialField: string
        +
        +

        the username credential field

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setUsernameField

    + +
      +
    • + +
      +
      +

      The property name to be used to set the name of the field, where the username is stored inside.

      +
      +
      +

      Parameters

      +
        +
      • +
        usernameField: string
        +
        +

        the username field

        +
        +
        • +
      +

      Returns MongoAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -379,38 +793,74 @@

    usernameField

  • MongoAuthOptions
    • diff --git a/docs/@vertx/auth-mongo/enums/hashalgorithm.html b/docs/@vertx/auth-mongo/enums/hashalgorithm.html index 141f5b7b1..9e0dce7f8 100644 --- a/docs/@vertx/auth-mongo/enums/hashalgorithm.html +++ b/docs/@vertx/auth-mongo/enums/hashalgorithm.html @@ -86,7 +86,7 @@

    PBKDF2

    PBKDF2:
    @@ -96,7 +96,7 @@

    SHA512

    SHA512:
    diff --git a/docs/@vertx/auth-mongo/enums/hashsaltstyle.html b/docs/@vertx/auth-mongo/enums/hashsaltstyle.html index b05ee9871..524a811c6 100644 --- a/docs/@vertx/auth-mongo/enums/hashsaltstyle.html +++ b/docs/@vertx/auth-mongo/enums/hashsaltstyle.html @@ -87,7 +87,7 @@

    COLUMN

    COLUMN:
    @@ -97,7 +97,7 @@

    EXTERNAL

    EXTERNAL:
    @@ -107,7 +107,7 @@

    NO_SALT

    NO_SALT:
    diff --git a/docs/@vertx/auth-oauth2/assets/js/search.js b/docs/@vertx/auth-oauth2/assets/js/search.js index 218ec475a..663088b75 100644 --- a/docs/@vertx/auth-oauth2/assets/js/search.js +++ b/docs/@vertx/auth-oauth2/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"OAuth2FlowType","url":"enums/oauth2flowtype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"AUTH_CODE","url":"enums/oauth2flowtype.html#auth_code","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":2,"kind":16,"name":"CLIENT","url":"enums/oauth2flowtype.html#client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":3,"kind":16,"name":"PASSWORD","url":"enums/oauth2flowtype.html#password","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":4,"kind":16,"name":"AUTH_JWT","url":"enums/oauth2flowtype.html#auth_jwt","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":5,"kind":128,"name":"OAuth2ClientOptions","url":"classes/oauth2clientoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":1024,"name":"alpnVersions","url":"classes/oauth2clientoptions.html#alpnversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":7,"kind":1024,"name":"authorizationPath","url":"classes/oauth2clientoptions.html#authorizationpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":8,"kind":1024,"name":"clientID","url":"classes/oauth2clientoptions.html#clientid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":9,"kind":1024,"name":"clientSecret","url":"classes/oauth2clientoptions.html#clientsecret","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":10,"kind":1024,"name":"clientSecretParameterName","url":"classes/oauth2clientoptions.html#clientsecretparametername","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":11,"kind":1024,"name":"connectTimeout","url":"classes/oauth2clientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":12,"kind":1024,"name":"crlPaths","url":"classes/oauth2clientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":13,"kind":1024,"name":"crlValues","url":"classes/oauth2clientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":14,"kind":1024,"name":"decoderInitialBufferSize","url":"classes/oauth2clientoptions.html#decoderinitialbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":15,"kind":1024,"name":"defaultHost","url":"classes/oauth2clientoptions.html#defaulthost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":16,"kind":1024,"name":"defaultPort","url":"classes/oauth2clientoptions.html#defaultport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":17,"kind":1024,"name":"enabledCipherSuites","url":"classes/oauth2clientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":18,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/oauth2clientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":19,"kind":1024,"name":"extraParameters","url":"classes/oauth2clientoptions.html#extraparameters","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":20,"kind":1024,"name":"forceSni","url":"classes/oauth2clientoptions.html#forcesni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":21,"kind":1024,"name":"headers","url":"classes/oauth2clientoptions.html#headers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":22,"kind":1024,"name":"http2ClearTextUpgrade","url":"classes/oauth2clientoptions.html#http2cleartextupgrade","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":23,"kind":1024,"name":"http2ConnectionWindowSize","url":"classes/oauth2clientoptions.html#http2connectionwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":24,"kind":1024,"name":"http2KeepAliveTimeout","url":"classes/oauth2clientoptions.html#http2keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":25,"kind":1024,"name":"http2MaxPoolSize","url":"classes/oauth2clientoptions.html#http2maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":26,"kind":1024,"name":"http2MultiplexingLimit","url":"classes/oauth2clientoptions.html#http2multiplexinglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":27,"kind":1024,"name":"idleTimeout","url":"classes/oauth2clientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":28,"kind":1024,"name":"initialSettings","url":"classes/oauth2clientoptions.html#initialsettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":29,"kind":1024,"name":"introspectionPath","url":"classes/oauth2clientoptions.html#introspectionpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":30,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/oauth2clientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":31,"kind":1024,"name":"jwkPath","url":"classes/oauth2clientoptions.html#jwkpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":32,"kind":1024,"name":"jwtOptions","url":"classes/oauth2clientoptions.html#jwtoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":33,"kind":1024,"name":"jwtToken","url":"classes/oauth2clientoptions.html#jwttoken","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":34,"kind":1024,"name":"keepAlive","url":"classes/oauth2clientoptions.html#keepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":35,"kind":1024,"name":"keepAliveTimeout","url":"classes/oauth2clientoptions.html#keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":36,"kind":1024,"name":"keyStoreOptions","url":"classes/oauth2clientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":37,"kind":1024,"name":"localAddress","url":"classes/oauth2clientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":38,"kind":1024,"name":"logActivity","url":"classes/oauth2clientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":39,"kind":1024,"name":"logoutPath","url":"classes/oauth2clientoptions.html#logoutpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":40,"kind":1024,"name":"maxChunkSize","url":"classes/oauth2clientoptions.html#maxchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":41,"kind":1024,"name":"maxHeaderSize","url":"classes/oauth2clientoptions.html#maxheadersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":42,"kind":1024,"name":"maxInitialLineLength","url":"classes/oauth2clientoptions.html#maxinitiallinelength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":43,"kind":1024,"name":"maxPoolSize","url":"classes/oauth2clientoptions.html#maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":44,"kind":1024,"name":"maxRedirects","url":"classes/oauth2clientoptions.html#maxredirects","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":45,"kind":1024,"name":"maxWaitQueueSize","url":"classes/oauth2clientoptions.html#maxwaitqueuesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":46,"kind":1024,"name":"maxWebsocketFrameSize","url":"classes/oauth2clientoptions.html#maxwebsocketframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":47,"kind":1024,"name":"maxWebsocketMessageSize","url":"classes/oauth2clientoptions.html#maxwebsocketmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":48,"kind":1024,"name":"metricsName","url":"classes/oauth2clientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":49,"kind":1024,"name":"openSslEngineOptions","url":"classes/oauth2clientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":50,"kind":1024,"name":"pemKeyCertOptions","url":"classes/oauth2clientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":51,"kind":1024,"name":"pemTrustOptions","url":"classes/oauth2clientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":52,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/oauth2clientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":53,"kind":1024,"name":"pfxTrustOptions","url":"classes/oauth2clientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":54,"kind":1024,"name":"pipelining","url":"classes/oauth2clientoptions.html#pipelining","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":55,"kind":1024,"name":"pipeliningLimit","url":"classes/oauth2clientoptions.html#pipelininglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":56,"kind":1024,"name":"poolCleanerPeriod","url":"classes/oauth2clientoptions.html#poolcleanerperiod","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":57,"kind":1024,"name":"protocolVersion","url":"classes/oauth2clientoptions.html#protocolversion","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":58,"kind":1024,"name":"proxyOptions","url":"classes/oauth2clientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":59,"kind":1024,"name":"pubSecKeys","url":"classes/oauth2clientoptions.html#pubseckeys","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":60,"kind":1024,"name":"receiveBufferSize","url":"classes/oauth2clientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":61,"kind":1024,"name":"reuseAddress","url":"classes/oauth2clientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":62,"kind":1024,"name":"reusePort","url":"classes/oauth2clientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":63,"kind":1024,"name":"revocationPath","url":"classes/oauth2clientoptions.html#revocationpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":64,"kind":1024,"name":"scopeSeparator","url":"classes/oauth2clientoptions.html#scopeseparator","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":65,"kind":1024,"name":"sendBufferSize","url":"classes/oauth2clientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":66,"kind":1024,"name":"sendUnmaskedFrames","url":"classes/oauth2clientoptions.html#sendunmaskedframes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":67,"kind":1024,"name":"site","url":"classes/oauth2clientoptions.html#site","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":68,"kind":1024,"name":"soLinger","url":"classes/oauth2clientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":69,"kind":1024,"name":"ssl","url":"classes/oauth2clientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":70,"kind":1024,"name":"tcpCork","url":"classes/oauth2clientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":71,"kind":1024,"name":"tcpFastOpen","url":"classes/oauth2clientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":72,"kind":1024,"name":"tcpKeepAlive","url":"classes/oauth2clientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":73,"kind":1024,"name":"tcpNoDelay","url":"classes/oauth2clientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":74,"kind":1024,"name":"tcpQuickAck","url":"classes/oauth2clientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":75,"kind":1024,"name":"tokenPath","url":"classes/oauth2clientoptions.html#tokenpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":76,"kind":1024,"name":"trafficClass","url":"classes/oauth2clientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":77,"kind":1024,"name":"trustAll","url":"classes/oauth2clientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":78,"kind":1024,"name":"trustStoreOptions","url":"classes/oauth2clientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":79,"kind":1024,"name":"tryUseCompression","url":"classes/oauth2clientoptions.html#tryusecompression","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":80,"kind":1024,"name":"useAlpn","url":"classes/oauth2clientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":81,"kind":1024,"name":"useBasicAuthorizationHeader","url":"classes/oauth2clientoptions.html#usebasicauthorizationheader","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":82,"kind":1024,"name":"usePooledBuffers","url":"classes/oauth2clientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":83,"kind":1024,"name":"userAgent","url":"classes/oauth2clientoptions.html#useragent","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":84,"kind":1024,"name":"userInfoParameters","url":"classes/oauth2clientoptions.html#userinfoparameters","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":85,"kind":1024,"name":"userInfoPath","url":"classes/oauth2clientoptions.html#userinfopath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":86,"kind":1024,"name":"verifyHost","url":"classes/oauth2clientoptions.html#verifyhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":87,"kind":128,"name":"AccessToken","url":"classes/accesstoken.html","classes":"tsd-kind-class"},{"id":88,"kind":2048,"name":"expired","url":"classes/accesstoken.html#expired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":89,"kind":2048,"name":"accessToken","url":"classes/accesstoken.html#accesstoken-1","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":90,"kind":2048,"name":"refreshToken","url":"classes/accesstoken.html#refreshtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":91,"kind":2048,"name":"idToken","url":"classes/accesstoken.html#idtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":92,"kind":2048,"name":"opaqueAccessToken","url":"classes/accesstoken.html#opaqueaccesstoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":93,"kind":2048,"name":"opaqueRefreshToken","url":"classes/accesstoken.html#opaquerefreshtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":94,"kind":2048,"name":"opaqueIdToken","url":"classes/accesstoken.html#opaqueidtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":95,"kind":2048,"name":"tokenType","url":"classes/accesstoken.html#tokentype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":96,"kind":2048,"name":"setTrustJWT","url":"classes/accesstoken.html#settrustjwt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":97,"kind":2048,"name":"refresh","url":"classes/accesstoken.html#refresh","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":98,"kind":2048,"name":"revoke","url":"classes/accesstoken.html#revoke","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":99,"kind":2048,"name":"logout","url":"classes/accesstoken.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":100,"kind":2048,"name":"introspect","url":"classes/accesstoken.html#introspect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":101,"kind":2048,"name":"userInfo","url":"classes/accesstoken.html#userinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":102,"kind":2048,"name":"fetch","url":"classes/accesstoken.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":103,"kind":128,"name":"AzureADAuth","url":"classes/azureadauth.html","classes":"tsd-kind-class"},{"id":104,"kind":2048,"name":"create","url":"classes/azureadauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"AzureADAuth"},{"id":105,"kind":128,"name":"BoxAuth","url":"classes/boxauth.html","classes":"tsd-kind-class"},{"id":106,"kind":2048,"name":"create","url":"classes/boxauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"BoxAuth"},{"id":107,"kind":128,"name":"CloudFoundryAuth","url":"classes/cloudfoundryauth.html","classes":"tsd-kind-class"},{"id":108,"kind":2048,"name":"create","url":"classes/cloudfoundryauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CloudFoundryAuth"},{"id":109,"kind":128,"name":"DropboxAuth","url":"classes/dropboxauth.html","classes":"tsd-kind-class"},{"id":110,"kind":2048,"name":"create","url":"classes/dropboxauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"DropboxAuth"},{"id":111,"kind":128,"name":"FacebookAuth","url":"classes/facebookauth.html","classes":"tsd-kind-class"},{"id":112,"kind":2048,"name":"create","url":"classes/facebookauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"FacebookAuth"},{"id":113,"kind":128,"name":"FoursquareAuth","url":"classes/foursquareauth.html","classes":"tsd-kind-class"},{"id":114,"kind":2048,"name":"create","url":"classes/foursquareauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"FoursquareAuth"},{"id":115,"kind":128,"name":"GithubAuth","url":"classes/githubauth.html","classes":"tsd-kind-class"},{"id":116,"kind":2048,"name":"create","url":"classes/githubauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"GithubAuth"},{"id":117,"kind":128,"name":"GoogleAuth","url":"classes/googleauth.html","classes":"tsd-kind-class"},{"id":118,"kind":2048,"name":"create","url":"classes/googleauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"GoogleAuth"},{"id":119,"kind":128,"name":"HerokuAuth","url":"classes/herokuauth.html","classes":"tsd-kind-class"},{"id":120,"kind":2048,"name":"create","url":"classes/herokuauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HerokuAuth"},{"id":121,"kind":128,"name":"InstagramAuth","url":"classes/instagramauth.html","classes":"tsd-kind-class"},{"id":122,"kind":2048,"name":"create","url":"classes/instagramauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"InstagramAuth"},{"id":123,"kind":128,"name":"KeycloakAuth","url":"classes/keycloakauth.html","classes":"tsd-kind-class"},{"id":124,"kind":2048,"name":"create","url":"classes/keycloakauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakAuth"},{"id":125,"kind":128,"name":"KeycloakHelper","url":"classes/keycloakhelper.html","classes":"tsd-kind-class"},{"id":126,"kind":2048,"name":"rawIdToken","url":"classes/keycloakhelper.html#rawidtoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":127,"kind":2048,"name":"idToken","url":"classes/keycloakhelper.html#idtoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":128,"kind":2048,"name":"rawAccessToken","url":"classes/keycloakhelper.html#rawaccesstoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":129,"kind":2048,"name":"accessToken","url":"classes/keycloakhelper.html#accesstoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":130,"kind":2048,"name":"authTime","url":"classes/keycloakhelper.html#authtime","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":131,"kind":2048,"name":"sessionState","url":"classes/keycloakhelper.html#sessionstate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":132,"kind":2048,"name":"acr","url":"classes/keycloakhelper.html#acr","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":133,"kind":2048,"name":"name","url":"classes/keycloakhelper.html#name","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":134,"kind":2048,"name":"email","url":"classes/keycloakhelper.html#email","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":135,"kind":2048,"name":"preferredUsername","url":"classes/keycloakhelper.html#preferredusername","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":136,"kind":2048,"name":"nickName","url":"classes/keycloakhelper.html#nickname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":137,"kind":2048,"name":"allowedOrigins","url":"classes/keycloakhelper.html#allowedorigins","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":138,"kind":2048,"name":"parseToken","url":"classes/keycloakhelper.html#parsetoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":139,"kind":128,"name":"LinkedInAuth","url":"classes/linkedinauth.html","classes":"tsd-kind-class"},{"id":140,"kind":2048,"name":"create","url":"classes/linkedinauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"LinkedInAuth"},{"id":141,"kind":128,"name":"LiveAuth","url":"classes/liveauth.html","classes":"tsd-kind-class"},{"id":142,"kind":2048,"name":"create","url":"classes/liveauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"LiveAuth"},{"id":143,"kind":128,"name":"MailchimpAuth","url":"classes/mailchimpauth.html","classes":"tsd-kind-class"},{"id":144,"kind":2048,"name":"create","url":"classes/mailchimpauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MailchimpAuth"},{"id":145,"kind":128,"name":"OAuth2Auth","url":"classes/oauth2auth.html","classes":"tsd-kind-class"},{"id":146,"kind":2048,"name":"verifyIsUsingPassword","url":"classes/oauth2auth.html#verifyisusingpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":147,"kind":2048,"name":"createKeycloak","url":"classes/oauth2auth.html#createkeycloak","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OAuth2Auth"},{"id":148,"kind":2048,"name":"create","url":"classes/oauth2auth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OAuth2Auth"},{"id":149,"kind":2048,"name":"authorizeURL","url":"classes/oauth2auth.html#authorizeurl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":150,"kind":2048,"name":"getToken","url":"classes/oauth2auth.html#gettoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":151,"kind":2048,"name":"hasJWTToken","url":"classes/oauth2auth.html#hasjwttoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":152,"kind":2048,"name":"decodeToken","url":"classes/oauth2auth.html#decodetoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":153,"kind":2048,"name":"introspectToken","url":"classes/oauth2auth.html#introspecttoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":154,"kind":2048,"name":"getScopeSeparator","url":"classes/oauth2auth.html#getscopeseparator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":155,"kind":2048,"name":"getFlowType","url":"classes/oauth2auth.html#getflowtype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":156,"kind":2048,"name":"loadJWK","url":"classes/oauth2auth.html#loadjwk","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":157,"kind":128,"name":"OAuth2Response","url":"classes/oauth2response.html","classes":"tsd-kind-class"},{"id":158,"kind":2048,"name":"statusCode","url":"classes/oauth2response.html#statuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":159,"kind":2048,"name":"headers","url":"classes/oauth2response.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":160,"kind":2048,"name":"getHeader","url":"classes/oauth2response.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":161,"kind":2048,"name":"body","url":"classes/oauth2response.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":162,"kind":2048,"name":"jsonObject","url":"classes/oauth2response.html#jsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":163,"kind":2048,"name":"jsonArray","url":"classes/oauth2response.html#jsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":164,"kind":2048,"name":"is","url":"classes/oauth2response.html#is","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":165,"kind":128,"name":"SalesforceAuth","url":"classes/salesforceauth.html","classes":"tsd-kind-class"},{"id":166,"kind":2048,"name":"create","url":"classes/salesforceauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SalesforceAuth"},{"id":167,"kind":128,"name":"ShopifyAuth","url":"classes/shopifyauth.html","classes":"tsd-kind-class"},{"id":168,"kind":2048,"name":"create","url":"classes/shopifyauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShopifyAuth"},{"id":169,"kind":128,"name":"SoundcloudAuth","url":"classes/soundcloudauth.html","classes":"tsd-kind-class"},{"id":170,"kind":2048,"name":"create","url":"classes/soundcloudauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SoundcloudAuth"},{"id":171,"kind":128,"name":"StripeAuth","url":"classes/stripeauth.html","classes":"tsd-kind-class"},{"id":172,"kind":2048,"name":"create","url":"classes/stripeauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StripeAuth"},{"id":173,"kind":128,"name":"TwitterAuth","url":"classes/twitterauth.html","classes":"tsd-kind-class"},{"id":174,"kind":2048,"name":"create","url":"classes/twitterauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TwitterAuth"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"OAuth2FlowType","url":"enums/oauth2flowtype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"AUTH_CODE","url":"enums/oauth2flowtype.html#auth_code","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":2,"kind":16,"name":"CLIENT","url":"enums/oauth2flowtype.html#client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":3,"kind":16,"name":"PASSWORD","url":"enums/oauth2flowtype.html#password","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":4,"kind":16,"name":"AUTH_JWT","url":"enums/oauth2flowtype.html#auth_jwt","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OAuth2FlowType"},{"id":5,"kind":128,"name":"OAuth2ClientOptions","url":"classes/oauth2clientoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":512,"name":"constructor","url":"classes/oauth2clientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":7,"kind":2048,"name":"getAlpnVersions","url":"classes/oauth2clientoptions.html#getalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":8,"kind":2048,"name":"setAlpnVersions","url":"classes/oauth2clientoptions.html#setalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":9,"kind":2048,"name":"getAuthorizationPath","url":"classes/oauth2clientoptions.html#getauthorizationpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":10,"kind":2048,"name":"setAuthorizationPath","url":"classes/oauth2clientoptions.html#setauthorizationpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":11,"kind":2048,"name":"getClientID","url":"classes/oauth2clientoptions.html#getclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":12,"kind":2048,"name":"setClientID","url":"classes/oauth2clientoptions.html#setclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":13,"kind":2048,"name":"getClientSecret","url":"classes/oauth2clientoptions.html#getclientsecret","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":14,"kind":2048,"name":"setClientSecret","url":"classes/oauth2clientoptions.html#setclientsecret","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":15,"kind":2048,"name":"getClientSecretParameterName","url":"classes/oauth2clientoptions.html#getclientsecretparametername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":16,"kind":2048,"name":"setClientSecretParameterName","url":"classes/oauth2clientoptions.html#setclientsecretparametername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":17,"kind":2048,"name":"getConnectTimeout","url":"classes/oauth2clientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":18,"kind":2048,"name":"setConnectTimeout","url":"classes/oauth2clientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":19,"kind":2048,"name":"getCrlPaths","url":"classes/oauth2clientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":20,"kind":2048,"name":"addCrlPath","url":"classes/oauth2clientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":21,"kind":2048,"name":"getCrlValues","url":"classes/oauth2clientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":22,"kind":2048,"name":"addCrlValue","url":"classes/oauth2clientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":23,"kind":2048,"name":"getDecoderInitialBufferSize","url":"classes/oauth2clientoptions.html#getdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":24,"kind":2048,"name":"setDecoderInitialBufferSize","url":"classes/oauth2clientoptions.html#setdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":25,"kind":2048,"name":"getDefaultHost","url":"classes/oauth2clientoptions.html#getdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":26,"kind":2048,"name":"setDefaultHost","url":"classes/oauth2clientoptions.html#setdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":27,"kind":2048,"name":"getDefaultPort","url":"classes/oauth2clientoptions.html#getdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":28,"kind":2048,"name":"setDefaultPort","url":"classes/oauth2clientoptions.html#setdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":29,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/oauth2clientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":30,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/oauth2clientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":31,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/oauth2clientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":32,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/oauth2clientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":33,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/oauth2clientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":34,"kind":2048,"name":"getExtraParameters","url":"classes/oauth2clientoptions.html#getextraparameters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":35,"kind":2048,"name":"setExtraParameters","url":"classes/oauth2clientoptions.html#setextraparameters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":36,"kind":2048,"name":"getFlow","url":"classes/oauth2clientoptions.html#getflow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":37,"kind":2048,"name":"setFlow","url":"classes/oauth2clientoptions.html#setflow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":38,"kind":2048,"name":"isForceSni","url":"classes/oauth2clientoptions.html#isforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":39,"kind":2048,"name":"setForceSni","url":"classes/oauth2clientoptions.html#setforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":40,"kind":2048,"name":"getHeaders","url":"classes/oauth2clientoptions.html#getheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":41,"kind":2048,"name":"setHeaders","url":"classes/oauth2clientoptions.html#setheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":42,"kind":2048,"name":"isHttp2ClearTextUpgrade","url":"classes/oauth2clientoptions.html#ishttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":43,"kind":2048,"name":"setHttp2ClearTextUpgrade","url":"classes/oauth2clientoptions.html#sethttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":44,"kind":2048,"name":"getHttp2ConnectionWindowSize","url":"classes/oauth2clientoptions.html#gethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":45,"kind":2048,"name":"setHttp2ConnectionWindowSize","url":"classes/oauth2clientoptions.html#sethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":46,"kind":2048,"name":"getHttp2KeepAliveTimeout","url":"classes/oauth2clientoptions.html#gethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":47,"kind":2048,"name":"setHttp2KeepAliveTimeout","url":"classes/oauth2clientoptions.html#sethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":48,"kind":2048,"name":"getHttp2MaxPoolSize","url":"classes/oauth2clientoptions.html#gethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":49,"kind":2048,"name":"setHttp2MaxPoolSize","url":"classes/oauth2clientoptions.html#sethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":50,"kind":2048,"name":"getHttp2MultiplexingLimit","url":"classes/oauth2clientoptions.html#gethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":51,"kind":2048,"name":"setHttp2MultiplexingLimit","url":"classes/oauth2clientoptions.html#sethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":52,"kind":2048,"name":"getIdleTimeout","url":"classes/oauth2clientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":53,"kind":2048,"name":"setIdleTimeout","url":"classes/oauth2clientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":54,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/oauth2clientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":55,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/oauth2clientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":56,"kind":2048,"name":"getInitialSettings","url":"classes/oauth2clientoptions.html#getinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":57,"kind":2048,"name":"setInitialSettings","url":"classes/oauth2clientoptions.html#setinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":58,"kind":2048,"name":"getIntrospectionPath","url":"classes/oauth2clientoptions.html#getintrospectionpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":59,"kind":2048,"name":"setIntrospectionPath","url":"classes/oauth2clientoptions.html#setintrospectionpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":60,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/oauth2clientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":61,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/oauth2clientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":62,"kind":2048,"name":"getJwkPath","url":"classes/oauth2clientoptions.html#getjwkpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":63,"kind":2048,"name":"setJwkPath","url":"classes/oauth2clientoptions.html#setjwkpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":64,"kind":2048,"name":"getJWTOptions","url":"classes/oauth2clientoptions.html#getjwtoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":65,"kind":2048,"name":"setJWTOptions","url":"classes/oauth2clientoptions.html#setjwtoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":66,"kind":2048,"name":"isKeepAlive","url":"classes/oauth2clientoptions.html#iskeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":67,"kind":2048,"name":"setKeepAlive","url":"classes/oauth2clientoptions.html#setkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":68,"kind":2048,"name":"getKeepAliveTimeout","url":"classes/oauth2clientoptions.html#getkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":69,"kind":2048,"name":"setKeepAliveTimeout","url":"classes/oauth2clientoptions.html#setkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":70,"kind":2048,"name":"getKeyStoreOptions","url":"classes/oauth2clientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":71,"kind":2048,"name":"setKeyStoreOptions","url":"classes/oauth2clientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":72,"kind":2048,"name":"getLocalAddress","url":"classes/oauth2clientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":73,"kind":2048,"name":"setLocalAddress","url":"classes/oauth2clientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":74,"kind":2048,"name":"getLogActivity","url":"classes/oauth2clientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":75,"kind":2048,"name":"setLogActivity","url":"classes/oauth2clientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":76,"kind":2048,"name":"getLogoutPath","url":"classes/oauth2clientoptions.html#getlogoutpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":77,"kind":2048,"name":"setLogoutPath","url":"classes/oauth2clientoptions.html#setlogoutpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":78,"kind":2048,"name":"getMaxChunkSize","url":"classes/oauth2clientoptions.html#getmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":79,"kind":2048,"name":"setMaxChunkSize","url":"classes/oauth2clientoptions.html#setmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":80,"kind":2048,"name":"getMaxHeaderSize","url":"classes/oauth2clientoptions.html#getmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":81,"kind":2048,"name":"setMaxHeaderSize","url":"classes/oauth2clientoptions.html#setmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":82,"kind":2048,"name":"getMaxInitialLineLength","url":"classes/oauth2clientoptions.html#getmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":83,"kind":2048,"name":"setMaxInitialLineLength","url":"classes/oauth2clientoptions.html#setmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":84,"kind":2048,"name":"getMaxPoolSize","url":"classes/oauth2clientoptions.html#getmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":85,"kind":2048,"name":"setMaxPoolSize","url":"classes/oauth2clientoptions.html#setmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":86,"kind":2048,"name":"getMaxRedirects","url":"classes/oauth2clientoptions.html#getmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":87,"kind":2048,"name":"setMaxRedirects","url":"classes/oauth2clientoptions.html#setmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":88,"kind":2048,"name":"getMaxWaitQueueSize","url":"classes/oauth2clientoptions.html#getmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":89,"kind":2048,"name":"setMaxWaitQueueSize","url":"classes/oauth2clientoptions.html#setmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":90,"kind":2048,"name":"getMaxWebsocketFrameSize","url":"classes/oauth2clientoptions.html#getmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":91,"kind":2048,"name":"setMaxWebsocketFrameSize","url":"classes/oauth2clientoptions.html#setmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":92,"kind":2048,"name":"getMaxWebsocketMessageSize","url":"classes/oauth2clientoptions.html#getmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":93,"kind":2048,"name":"setMaxWebsocketMessageSize","url":"classes/oauth2clientoptions.html#setmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":94,"kind":2048,"name":"getMetricsName","url":"classes/oauth2clientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":95,"kind":2048,"name":"setMetricsName","url":"classes/oauth2clientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":96,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/oauth2clientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":97,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/oauth2clientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":98,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/oauth2clientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":99,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/oauth2clientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":100,"kind":2048,"name":"getPemTrustOptions","url":"classes/oauth2clientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":101,"kind":2048,"name":"setPemTrustOptions","url":"classes/oauth2clientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":102,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/oauth2clientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":103,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/oauth2clientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":104,"kind":2048,"name":"getPfxTrustOptions","url":"classes/oauth2clientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":105,"kind":2048,"name":"setPfxTrustOptions","url":"classes/oauth2clientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":106,"kind":2048,"name":"isPipelining","url":"classes/oauth2clientoptions.html#ispipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":107,"kind":2048,"name":"setPipelining","url":"classes/oauth2clientoptions.html#setpipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":108,"kind":2048,"name":"getPipeliningLimit","url":"classes/oauth2clientoptions.html#getpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":109,"kind":2048,"name":"setPipeliningLimit","url":"classes/oauth2clientoptions.html#setpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":110,"kind":2048,"name":"getPoolCleanerPeriod","url":"classes/oauth2clientoptions.html#getpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":111,"kind":2048,"name":"setPoolCleanerPeriod","url":"classes/oauth2clientoptions.html#setpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":112,"kind":2048,"name":"getProtocolVersion","url":"classes/oauth2clientoptions.html#getprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":113,"kind":2048,"name":"setProtocolVersion","url":"classes/oauth2clientoptions.html#setprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":114,"kind":2048,"name":"getProxyOptions","url":"classes/oauth2clientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":115,"kind":2048,"name":"setProxyOptions","url":"classes/oauth2clientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":116,"kind":2048,"name":"getPubSecKeys","url":"classes/oauth2clientoptions.html#getpubseckeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":117,"kind":2048,"name":"setPubSecKeys","url":"classes/oauth2clientoptions.html#setpubseckeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":118,"kind":2048,"name":"addPubSecKey","url":"classes/oauth2clientoptions.html#addpubseckey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":119,"kind":2048,"name":"getReceiveBufferSize","url":"classes/oauth2clientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":120,"kind":2048,"name":"setReceiveBufferSize","url":"classes/oauth2clientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":121,"kind":2048,"name":"isReuseAddress","url":"classes/oauth2clientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":122,"kind":2048,"name":"setReuseAddress","url":"classes/oauth2clientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":123,"kind":2048,"name":"isReusePort","url":"classes/oauth2clientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":124,"kind":2048,"name":"setReusePort","url":"classes/oauth2clientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":125,"kind":2048,"name":"getRevocationPath","url":"classes/oauth2clientoptions.html#getrevocationpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":126,"kind":2048,"name":"setRevocationPath","url":"classes/oauth2clientoptions.html#setrevocationpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":127,"kind":2048,"name":"getScopeSeparator","url":"classes/oauth2clientoptions.html#getscopeseparator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":128,"kind":2048,"name":"setScopeSeparator","url":"classes/oauth2clientoptions.html#setscopeseparator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":129,"kind":2048,"name":"getSendBufferSize","url":"classes/oauth2clientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":130,"kind":2048,"name":"setSendBufferSize","url":"classes/oauth2clientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":131,"kind":2048,"name":"isSendUnmaskedFrames","url":"classes/oauth2clientoptions.html#issendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":132,"kind":2048,"name":"setSendUnmaskedFrames","url":"classes/oauth2clientoptions.html#setsendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":133,"kind":2048,"name":"getSite","url":"classes/oauth2clientoptions.html#getsite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":134,"kind":2048,"name":"setSite","url":"classes/oauth2clientoptions.html#setsite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":135,"kind":2048,"name":"getSoLinger","url":"classes/oauth2clientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":136,"kind":2048,"name":"setSoLinger","url":"classes/oauth2clientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":137,"kind":2048,"name":"isSsl","url":"classes/oauth2clientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":138,"kind":2048,"name":"setSsl","url":"classes/oauth2clientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":139,"kind":2048,"name":"isTcpCork","url":"classes/oauth2clientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":140,"kind":2048,"name":"setTcpCork","url":"classes/oauth2clientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":141,"kind":2048,"name":"isTcpFastOpen","url":"classes/oauth2clientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":142,"kind":2048,"name":"setTcpFastOpen","url":"classes/oauth2clientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":143,"kind":2048,"name":"isTcpKeepAlive","url":"classes/oauth2clientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":144,"kind":2048,"name":"setTcpKeepAlive","url":"classes/oauth2clientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":145,"kind":2048,"name":"isTcpNoDelay","url":"classes/oauth2clientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":146,"kind":2048,"name":"setTcpNoDelay","url":"classes/oauth2clientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":147,"kind":2048,"name":"isTcpQuickAck","url":"classes/oauth2clientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":148,"kind":2048,"name":"setTcpQuickAck","url":"classes/oauth2clientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":149,"kind":2048,"name":"getTokenPath","url":"classes/oauth2clientoptions.html#gettokenpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":150,"kind":2048,"name":"setTokenPath","url":"classes/oauth2clientoptions.html#settokenpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":151,"kind":2048,"name":"getTrafficClass","url":"classes/oauth2clientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":152,"kind":2048,"name":"setTrafficClass","url":"classes/oauth2clientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":153,"kind":2048,"name":"isTrustAll","url":"classes/oauth2clientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":154,"kind":2048,"name":"setTrustAll","url":"classes/oauth2clientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":155,"kind":2048,"name":"getTrustStoreOptions","url":"classes/oauth2clientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":156,"kind":2048,"name":"setTrustStoreOptions","url":"classes/oauth2clientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":157,"kind":2048,"name":"isTryUseCompression","url":"classes/oauth2clientoptions.html#istryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":158,"kind":2048,"name":"setTryUseCompression","url":"classes/oauth2clientoptions.html#settryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":159,"kind":2048,"name":"tryUsePerFrameWebsocketCompression","url":"classes/oauth2clientoptions.html#tryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":160,"kind":2048,"name":"setTryUsePerFrameWebsocketCompression","url":"classes/oauth2clientoptions.html#settryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":161,"kind":2048,"name":"tryUsePerMessageWebsocketCompression","url":"classes/oauth2clientoptions.html#tryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":162,"kind":2048,"name":"setTryUsePerMessageWebsocketCompression","url":"classes/oauth2clientoptions.html#settryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":163,"kind":2048,"name":"isUseAlpn","url":"classes/oauth2clientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":164,"kind":2048,"name":"setUseAlpn","url":"classes/oauth2clientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":165,"kind":2048,"name":"isUseBasicAuthorizationHeader","url":"classes/oauth2clientoptions.html#isusebasicauthorizationheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":166,"kind":2048,"name":"setUseBasicAuthorizationHeader","url":"classes/oauth2clientoptions.html#setusebasicauthorizationheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":167,"kind":2048,"name":"isUsePooledBuffers","url":"classes/oauth2clientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":168,"kind":2048,"name":"setUsePooledBuffers","url":"classes/oauth2clientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":169,"kind":2048,"name":"getUserAgent","url":"classes/oauth2clientoptions.html#getuseragent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":170,"kind":2048,"name":"setUserAgent","url":"classes/oauth2clientoptions.html#setuseragent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":171,"kind":2048,"name":"getUserInfoParameters","url":"classes/oauth2clientoptions.html#getuserinfoparameters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":172,"kind":2048,"name":"setUserInfoParameters","url":"classes/oauth2clientoptions.html#setuserinfoparameters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":173,"kind":2048,"name":"getUserInfoPath","url":"classes/oauth2clientoptions.html#getuserinfopath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":174,"kind":2048,"name":"setUserInfoPath","url":"classes/oauth2clientoptions.html#setuserinfopath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":175,"kind":2048,"name":"isValidateIssuer","url":"classes/oauth2clientoptions.html#isvalidateissuer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":176,"kind":2048,"name":"setValidateIssuer","url":"classes/oauth2clientoptions.html#setvalidateissuer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":177,"kind":2048,"name":"isVerifyHost","url":"classes/oauth2clientoptions.html#isverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":178,"kind":2048,"name":"setVerifyHost","url":"classes/oauth2clientoptions.html#setverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":179,"kind":2048,"name":"getWebsocketCompressionAllowClientNoContext","url":"classes/oauth2clientoptions.html#getwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":180,"kind":2048,"name":"setWebsocketCompressionAllowClientNoContext","url":"classes/oauth2clientoptions.html#setwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":181,"kind":2048,"name":"getWebsocketCompressionLevel","url":"classes/oauth2clientoptions.html#getwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":182,"kind":2048,"name":"setWebsocketCompressionLevel","url":"classes/oauth2clientoptions.html#setwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":183,"kind":2048,"name":"getWebsocketCompressionRequestServerNoContext","url":"classes/oauth2clientoptions.html#getwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":184,"kind":2048,"name":"setWebsocketCompressionRequestServerNoContext","url":"classes/oauth2clientoptions.html#setwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2ClientOptions"},{"id":185,"kind":128,"name":"AccessToken","url":"classes/accesstoken.html","classes":"tsd-kind-class"},{"id":186,"kind":2048,"name":"expired","url":"classes/accesstoken.html#expired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":187,"kind":2048,"name":"accessToken","url":"classes/accesstoken.html#accesstoken-1","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":188,"kind":2048,"name":"refreshToken","url":"classes/accesstoken.html#refreshtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":189,"kind":2048,"name":"idToken","url":"classes/accesstoken.html#idtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":190,"kind":2048,"name":"opaqueAccessToken","url":"classes/accesstoken.html#opaqueaccesstoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":191,"kind":2048,"name":"opaqueRefreshToken","url":"classes/accesstoken.html#opaquerefreshtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":192,"kind":2048,"name":"opaqueIdToken","url":"classes/accesstoken.html#opaqueidtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":193,"kind":2048,"name":"tokenType","url":"classes/accesstoken.html#tokentype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":194,"kind":2048,"name":"setTrustJWT","url":"classes/accesstoken.html#settrustjwt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":195,"kind":2048,"name":"refresh","url":"classes/accesstoken.html#refresh","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":196,"kind":2048,"name":"revoke","url":"classes/accesstoken.html#revoke","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":197,"kind":2048,"name":"logout","url":"classes/accesstoken.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":198,"kind":2048,"name":"introspect","url":"classes/accesstoken.html#introspect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":199,"kind":2048,"name":"userInfo","url":"classes/accesstoken.html#userinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":200,"kind":2048,"name":"fetch","url":"classes/accesstoken.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AccessToken"},{"id":201,"kind":128,"name":"AzureADAuth","url":"classes/azureadauth.html","classes":"tsd-kind-class"},{"id":202,"kind":2048,"name":"create","url":"classes/azureadauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"AzureADAuth"},{"id":203,"kind":2048,"name":"discover","url":"classes/azureadauth.html#discover","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-static","parent":"AzureADAuth"},{"id":204,"kind":128,"name":"BoxAuth","url":"classes/boxauth.html","classes":"tsd-kind-class"},{"id":205,"kind":2048,"name":"create","url":"classes/boxauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"BoxAuth"},{"id":206,"kind":128,"name":"CloudFoundryAuth","url":"classes/cloudfoundryauth.html","classes":"tsd-kind-class"},{"id":207,"kind":2048,"name":"create","url":"classes/cloudfoundryauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CloudFoundryAuth"},{"id":208,"kind":128,"name":"DropboxAuth","url":"classes/dropboxauth.html","classes":"tsd-kind-class"},{"id":209,"kind":2048,"name":"create","url":"classes/dropboxauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"DropboxAuth"},{"id":210,"kind":128,"name":"FacebookAuth","url":"classes/facebookauth.html","classes":"tsd-kind-class"},{"id":211,"kind":2048,"name":"create","url":"classes/facebookauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"FacebookAuth"},{"id":212,"kind":128,"name":"FoursquareAuth","url":"classes/foursquareauth.html","classes":"tsd-kind-class"},{"id":213,"kind":2048,"name":"create","url":"classes/foursquareauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"FoursquareAuth"},{"id":214,"kind":128,"name":"GithubAuth","url":"classes/githubauth.html","classes":"tsd-kind-class"},{"id":215,"kind":2048,"name":"create","url":"classes/githubauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"GithubAuth"},{"id":216,"kind":128,"name":"GoogleAuth","url":"classes/googleauth.html","classes":"tsd-kind-class"},{"id":217,"kind":2048,"name":"create","url":"classes/googleauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"GoogleAuth"},{"id":218,"kind":2048,"name":"discover","url":"classes/googleauth.html#discover","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-static","parent":"GoogleAuth"},{"id":219,"kind":128,"name":"HerokuAuth","url":"classes/herokuauth.html","classes":"tsd-kind-class"},{"id":220,"kind":2048,"name":"create","url":"classes/herokuauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HerokuAuth"},{"id":221,"kind":128,"name":"InstagramAuth","url":"classes/instagramauth.html","classes":"tsd-kind-class"},{"id":222,"kind":2048,"name":"create","url":"classes/instagramauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"InstagramAuth"},{"id":223,"kind":128,"name":"KeycloakAuth","url":"classes/keycloakauth.html","classes":"tsd-kind-class"},{"id":224,"kind":2048,"name":"create","url":"classes/keycloakauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakAuth"},{"id":225,"kind":2048,"name":"discover","url":"classes/keycloakauth.html#discover","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-static","parent":"KeycloakAuth"},{"id":226,"kind":128,"name":"KeycloakHelper","url":"classes/keycloakhelper.html","classes":"tsd-kind-class"},{"id":227,"kind":2048,"name":"rawIdToken","url":"classes/keycloakhelper.html#rawidtoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":228,"kind":2048,"name":"idToken","url":"classes/keycloakhelper.html#idtoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":229,"kind":2048,"name":"rawAccessToken","url":"classes/keycloakhelper.html#rawaccesstoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":230,"kind":2048,"name":"accessToken","url":"classes/keycloakhelper.html#accesstoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":231,"kind":2048,"name":"authTime","url":"classes/keycloakhelper.html#authtime","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":232,"kind":2048,"name":"sessionState","url":"classes/keycloakhelper.html#sessionstate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":233,"kind":2048,"name":"acr","url":"classes/keycloakhelper.html#acr","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":234,"kind":2048,"name":"name","url":"classes/keycloakhelper.html#name","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":235,"kind":2048,"name":"email","url":"classes/keycloakhelper.html#email","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":236,"kind":2048,"name":"preferredUsername","url":"classes/keycloakhelper.html#preferredusername","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":237,"kind":2048,"name":"nickName","url":"classes/keycloakhelper.html#nickname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":238,"kind":2048,"name":"allowedOrigins","url":"classes/keycloakhelper.html#allowedorigins","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":239,"kind":2048,"name":"parseToken","url":"classes/keycloakhelper.html#parsetoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakHelper"},{"id":240,"kind":128,"name":"KeycloakRBAC","url":"classes/keycloakrbac.html","classes":"tsd-kind-class"},{"id":241,"kind":2048,"name":"create","url":"classes/keycloakrbac.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KeycloakRBAC"},{"id":242,"kind":128,"name":"LinkedInAuth","url":"classes/linkedinauth.html","classes":"tsd-kind-class"},{"id":243,"kind":2048,"name":"create","url":"classes/linkedinauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"LinkedInAuth"},{"id":244,"kind":128,"name":"LiveAuth","url":"classes/liveauth.html","classes":"tsd-kind-class"},{"id":245,"kind":2048,"name":"create","url":"classes/liveauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"LiveAuth"},{"id":246,"kind":128,"name":"MailchimpAuth","url":"classes/mailchimpauth.html","classes":"tsd-kind-class"},{"id":247,"kind":2048,"name":"create","url":"classes/mailchimpauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MailchimpAuth"},{"id":248,"kind":128,"name":"MicroProfileRBAC","url":"classes/microprofilerbac.html","classes":"tsd-kind-class"},{"id":249,"kind":2048,"name":"create","url":"classes/microprofilerbac.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MicroProfileRBAC"},{"id":250,"kind":128,"name":"OAuth2Auth","url":"classes/oauth2auth.html","classes":"tsd-kind-class"},{"id":251,"kind":2048,"name":"createKeycloak","url":"classes/oauth2auth.html#createkeycloak","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OAuth2Auth"},{"id":252,"kind":2048,"name":"create","url":"classes/oauth2auth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OAuth2Auth"},{"id":253,"kind":2048,"name":"authorizeURL","url":"classes/oauth2auth.html#authorizeurl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":254,"kind":2048,"name":"getToken","url":"classes/oauth2auth.html#gettoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":255,"kind":2048,"name":"decodeToken","url":"classes/oauth2auth.html#decodetoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":256,"kind":2048,"name":"introspectToken","url":"classes/oauth2auth.html#introspecttoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":257,"kind":2048,"name":"getScopeSeparator","url":"classes/oauth2auth.html#getscopeseparator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":258,"kind":2048,"name":"getFlowType","url":"classes/oauth2auth.html#getflowtype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":259,"kind":2048,"name":"loadJWK","url":"classes/oauth2auth.html#loadjwk","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":260,"kind":2048,"name":"rbacHandler","url":"classes/oauth2auth.html#rbachandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Auth"},{"id":261,"kind":128,"name":"OAuth2RBAC","url":"classes/oauth2rbac.html","classes":"tsd-kind-class"},{"id":262,"kind":2048,"name":"isAuthorized","url":"classes/oauth2rbac.html#isauthorized","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2RBAC"},{"id":263,"kind":128,"name":"OAuth2Response","url":"classes/oauth2response.html","classes":"tsd-kind-class"},{"id":264,"kind":2048,"name":"statusCode","url":"classes/oauth2response.html#statuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":265,"kind":2048,"name":"headers","url":"classes/oauth2response.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":266,"kind":2048,"name":"getHeader","url":"classes/oauth2response.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":267,"kind":2048,"name":"body","url":"classes/oauth2response.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":268,"kind":2048,"name":"jsonObject","url":"classes/oauth2response.html#jsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":269,"kind":2048,"name":"jsonArray","url":"classes/oauth2response.html#jsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":270,"kind":2048,"name":"is","url":"classes/oauth2response.html#is","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OAuth2Response"},{"id":271,"kind":128,"name":"OpenIDConnectAuth","url":"classes/openidconnectauth.html","classes":"tsd-kind-class"},{"id":272,"kind":2048,"name":"discover","url":"classes/openidconnectauth.html#discover","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OpenIDConnectAuth"},{"id":273,"kind":128,"name":"SalesforceAuth","url":"classes/salesforceauth.html","classes":"tsd-kind-class"},{"id":274,"kind":2048,"name":"create","url":"classes/salesforceauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SalesforceAuth"},{"id":275,"kind":2048,"name":"discover","url":"classes/salesforceauth.html#discover","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-static","parent":"SalesforceAuth"},{"id":276,"kind":128,"name":"ShopifyAuth","url":"classes/shopifyauth.html","classes":"tsd-kind-class"},{"id":277,"kind":2048,"name":"create","url":"classes/shopifyauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShopifyAuth"},{"id":278,"kind":128,"name":"SoundcloudAuth","url":"classes/soundcloudauth.html","classes":"tsd-kind-class"},{"id":279,"kind":2048,"name":"create","url":"classes/soundcloudauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SoundcloudAuth"},{"id":280,"kind":128,"name":"StripeAuth","url":"classes/stripeauth.html","classes":"tsd-kind-class"},{"id":281,"kind":2048,"name":"create","url":"classes/stripeauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StripeAuth"},{"id":282,"kind":128,"name":"TwitterAuth","url":"classes/twitterauth.html","classes":"tsd-kind-class"},{"id":283,"kind":2048,"name":"create","url":"classes/twitterauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TwitterAuth"}]}; \ No newline at end of file diff --git a/docs/@vertx/auth-oauth2/classes/accesstoken.html b/docs/@vertx/auth-oauth2/classes/accesstoken.html index a324639ed..33148b191 100644 --- a/docs/@vertx/auth-oauth2/classes/accesstoken.html +++ b/docs/@vertx/auth-oauth2/classes/accesstoken.html @@ -68,7 +68,12 @@

    Class AccessToken

    Hierarchy

    • - AccessToken + any +
        +
      • + AccessToken +
        • +
    @@ -111,16 +116,21 @@

    accessToken

  • -

    The Access Token if present parsed as a JsonObject

    +

    The Access Token if present parsed as a JsonObject

    Returns object

    JSON

    +
      +
    • +
      [key: string]: any
      +
      • +
    • @@ -134,12 +144,12 @@

    expired

  • -

    Check if the access token is expired or not.

    +

    Check if the access token is expired or not.

    Returns boolean

    @@ -157,12 +167,12 @@

    fetch

  • -

    Fetches a JSON resource using this Access Token.

    +

    Fetches a JSON resource using this Access Token.

    Parameters

    @@ -181,17 +191,20 @@
    callback: function
    • @@ -300,12 +326,12 @@

    introspect

  • -

    Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

    +

    Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

    Parameters

    @@ -318,17 +344,20 @@
    callback: function
    • @@ -462,10 +503,16 @@

    opaqueIdToken

  • +
    +
    +

    The RAW String if available for the Id Token

    +
    +

    Returns string

    +

    String

    • @@ -479,10 +526,16 @@

    opaqueRefreshToken

  • +
    +
    +

    The RAW String if available for the Refresh Token

    +
    +

    Returns string

    +

    String

    • @@ -496,12 +549,12 @@

    refresh

  • -

    Refresh the access token

    +

    Refresh the access token

    Parameters

    @@ -514,17 +567,20 @@
    callback: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -545,16 +601,21 @@

      refreshToken

    • -

      The Refresh Token if present parsed as a JsonObject

      +

      The Refresh Token if present parsed as a JsonObject

      Returns object

      JSON

      +
        +
      • +
        [key: string]: any
        +
        • +
    • @@ -568,12 +629,12 @@

    revoke

  • -

    Revoke access or refresh token

    +

    Revoke access or refresh token

    Parameters

    @@ -592,17 +653,20 @@
    callback: function
    • @@ -80,6 +85,7 @@

    Index

    Methods

    @@ -98,12 +104,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Microsoft Azure Active Directory

    +

    Create a OAuth2Auth provider for Microsoft Azure Active Directory

    Parameters

    @@ -135,12 +141,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Microsoft Azure Active Directory

    +

    Create a OAuth2Auth provider for Microsoft Azure Active Directory

    Parameters

    @@ -177,6 +183,76 @@

    Returns + +

    Static discover

    + +
      +
    • + +
      +
      +

      Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the + configuration options and attempt to load the well known descriptor. If a site is provided (for example when + running on a custom instance) that site will be used to do the lookup. +

      + If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded + into the OAuth provider so tokens can be decoded.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        +

        the vertx instance

        +
        +
        • +
      • +
        config: OAuth2ClientOptions
        +
        +

        the initial config

        +
        +
        • +
      • +
        handler: function
        +
        +

        the instantiated Oauth2 provider instance handler

        +
        +
          +
        • + +
            +
          • +

            Parameters

            + +

            Returns void + | + Handler<AsyncResult<OAuth2Auth>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns void

      +
      • +
    +

    • @@ -203,6 +279,9 @@

    Returns create +
  • + discover +
    • @@ -240,6 +319,9 @@

    Returns KeycloakHelper +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -249,15 +331,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/boxauth.html b/docs/@vertx/auth-oauth2/classes/boxauth.html index 207f8a486..90cedaca6 100644 --- a/docs/@vertx/auth-oauth2/classes/boxauth.html +++ b/docs/@vertx/auth-oauth2/classes/boxauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for App.net

    +

    Create a OAuth2Auth provider for App.net

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for App.net

    +

    Create a OAuth2Auth provider for App.net

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/cloudfoundryauth.html b/docs/@vertx/auth-oauth2/classes/cloudfoundryauth.html index 9814ad720..f8be6563e 100644 --- a/docs/@vertx/auth-oauth2/classes/cloudfoundryauth.html +++ b/docs/@vertx/auth-oauth2/classes/cloudfoundryauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for CloudFoundry UAA

    +

    Create a OAuth2Auth provider for CloudFoundry UAA

    Parameters

    @@ -135,12 +135,12 @@

    Returns
    -

    Create a OAuth2Auth provider for CloudFoundry UAA

    +

    Create a OAuth2Auth provider for CloudFoundry UAA

    Parameters

    @@ -240,6 +240,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -249,15 +252,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/dropboxauth.html b/docs/@vertx/auth-oauth2/classes/dropboxauth.html index 6d65ebae0..02fe5c007 100644 --- a/docs/@vertx/auth-oauth2/classes/dropboxauth.html +++ b/docs/@vertx/auth-oauth2/classes/dropboxauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Dropbox

    +

    Create a OAuth2Auth provider for Dropbox

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Dropbox

    +

    Create a OAuth2Auth provider for Dropbox

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/facebookauth.html b/docs/@vertx/auth-oauth2/classes/facebookauth.html index 678b2b6f0..771212ad6 100644 --- a/docs/@vertx/auth-oauth2/classes/facebookauth.html +++ b/docs/@vertx/auth-oauth2/classes/facebookauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Facebook

    +

    Create a OAuth2Auth provider for Facebook

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Facebook

    +

    Create a OAuth2Auth provider for Facebook

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/foursquareauth.html b/docs/@vertx/auth-oauth2/classes/foursquareauth.html index 53b906404..aae2c03dd 100644 --- a/docs/@vertx/auth-oauth2/classes/foursquareauth.html +++ b/docs/@vertx/auth-oauth2/classes/foursquareauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Foursquare

    +

    Create a OAuth2Auth provider for Foursquare

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Foursquare

    +

    Create a OAuth2Auth provider for Foursquare

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/githubauth.html b/docs/@vertx/auth-oauth2/classes/githubauth.html index d41ed1f37..f09fc4449 100644 --- a/docs/@vertx/auth-oauth2/classes/githubauth.html +++ b/docs/@vertx/auth-oauth2/classes/githubauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Gtihub

    +

    Create a OAuth2Auth provider for Github

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Gtihub

    +

    Create a OAuth2Auth provider for Github

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/googleauth.html b/docs/@vertx/auth-oauth2/classes/googleauth.html index 61ae9c354..1117b467c 100644 --- a/docs/@vertx/auth-oauth2/classes/googleauth.html +++ b/docs/@vertx/auth-oauth2/classes/googleauth.html @@ -68,7 +68,12 @@

    Class GoogleAuth

    Hierarchy

    @@ -80,6 +85,7 @@

    Index

    Methods

    @@ -100,12 +106,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Google

    +

    Create a OAuth2Auth provider for Google

    Parameters

    @@ -131,12 +137,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Google

    +

    Create a OAuth2Auth provider for Google

    Parameters

    @@ -168,12 +174,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Google Service Account (Server to Server)

    +

    Create a OAuth2Auth provider for Google Service Account (Server to Server)

    Parameters

    @@ -186,6 +192,11 @@
    serviceAccountJson: object

    the configuration json file from your Google API page

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns OAuth2Auth

    @@ -193,12 +204,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Google Service Account (Server to Server)

    +

    Create a OAuth2Auth provider for Google Service Account (Server to Server)

    Parameters

    @@ -211,6 +222,11 @@
    serviceAccountJson: object

    the configuration json file from your Google API page

    +
      +
    • +
      [key: string]: any
      +
      • +
  • httpClientOptions: HttpClientOptions
    @@ -223,6 +239,76 @@

    Returns + +

    Static discover

    + +
      +
    • + +
      +
      +

      Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the + configuration options and attempt to load the well known descriptor. If a site is provided (for example when + running on a custom instance) that site will be used to do the lookup. +

      + If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded + into the OAuth provider so tokens can be decoded.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        +

        the vertx instance

        +
        +
        • +
      • +
        config: OAuth2ClientOptions
        +
        +

        the initial config

        +
        +
        • +
      • +
        handler: function
        +
        +

        the instantiated Oauth2 provider instance handler

        +
        +
          +
        • + +
            +
          • +

            Parameters

            + +

            Returns void + | + Handler<AsyncResult<OAuth2Auth>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns void

      +
      • +
    +

    • @@ -270,6 +356,9 @@

    Returns create +
  • + discover +
    • @@ -286,6 +375,9 @@

    Returns KeycloakHelper +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -295,15 +387,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/herokuauth.html b/docs/@vertx/auth-oauth2/classes/herokuauth.html index 8bdbe8f49..e5d6bb92e 100644 --- a/docs/@vertx/auth-oauth2/classes/herokuauth.html +++ b/docs/@vertx/auth-oauth2/classes/herokuauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Heroku

    +

    Create a OAuth2Auth provider for Heroku

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Heroku

    +

    Create a OAuth2Auth provider for Heroku

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/instagramauth.html b/docs/@vertx/auth-oauth2/classes/instagramauth.html index 2d9fa0196..4e82d1c99 100644 --- a/docs/@vertx/auth-oauth2/classes/instagramauth.html +++ b/docs/@vertx/auth-oauth2/classes/instagramauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Instagram

    +

    Create a OAuth2Auth provider for Instagram

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Instagram

    +

    Create a OAuth2Auth provider for Instagram

    Parameters

    @@ -228,6 +228,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -237,15 +240,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/keycloakauth.html b/docs/@vertx/auth-oauth2/classes/keycloakauth.html index 4e42307a4..aa2f4dea9 100644 --- a/docs/@vertx/auth-oauth2/classes/keycloakauth.html +++ b/docs/@vertx/auth-oauth2/classes/keycloakauth.html @@ -68,7 +68,12 @@

    Class KeycloakAuth

    Hierarchy

    @@ -80,6 +85,7 @@

    Index

    Methods

    @@ -100,12 +106,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Keycloak

    +

    Create a OAuth2Auth provider for Keycloak

    Parameters

    @@ -118,6 +124,11 @@
    config: object

    the json config file exported from Keycloak admin console

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns OAuth2Auth

    @@ -125,12 +136,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Keycloak

    +

    Create a OAuth2Auth provider for Keycloak

    Parameters

    @@ -149,6 +160,11 @@
    config: object

    the json config file exported from Keycloak admin console

    +
      +
    • +
      [key: string]: any
      +
      • +

    Returns OAuth2Auth

    @@ -156,12 +172,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Keycloak

    +

    Create a OAuth2Auth provider for Keycloak

    Parameters

    @@ -174,6 +190,11 @@
    config: object

    the json config file exported from Keycloak admin console

    +
      +
    • +
      [key: string]: any
      +
      • +
  • httpClientOptions: HttpClientOptions
    @@ -187,12 +208,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Keycloak

    +

    Create a OAuth2Auth provider for Keycloak

    Parameters

    @@ -211,6 +232,11 @@
    config: object

    the json config file exported from Keycloak admin console

    +
      +
    • +
      [key: string]: any
      +
      • +

  • httpClientOptions: HttpClientOptions
    @@ -223,6 +249,76 @@

    Returns + +

    Static discover

    + +
      +
    • + +
      +
      +

      Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the + configuration options and attempt to load the well known descriptor. If a site is provided (for example when + running on a custom instance) that site will be used to do the lookup. +

      + If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded + into the OAuth provider so tokens can be decoded.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        +

        the vertx instance

        +
        +
        • +
      • +
        config: OAuth2ClientOptions
        +
        +

        the initial config

        +
        +
        • +
      • +
        handler: function
        +
        +

        the instantiated Oauth2 provider instance handler

        +
        +
          +
        • + +
            +
          • +

            Parameters

            + +

            Returns void + | + Handler<AsyncResult<OAuth2Auth>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns void

      +
      • +
    +

    • @@ -279,6 +375,9 @@

    Returns create +
  • + discover +
    • @@ -286,6 +385,9 @@

    Returns KeycloakHelper +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -295,15 +397,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/keycloakhelper.html b/docs/@vertx/auth-oauth2/classes/keycloakhelper.html index 5475e5978..bbf5b9535 100644 --- a/docs/@vertx/auth-oauth2/classes/keycloakhelper.html +++ b/docs/@vertx/auth-oauth2/classes/keycloakhelper.html @@ -109,12 +109,12 @@

    Static accessToken

  • -

    Get decoded access_token from the principal.

    +

    Get decoded access_token from the principal.

    Parameters

    @@ -124,10 +124,20 @@
    principal: object

    user principal

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns object

    the access token

    +
      +
    • +
      [key: string]: any
      +
      • +
    @@ -141,13 +151,18 @@

    Static acr

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -164,13 +179,18 @@

    Static allowedOrigins

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string[]

    @@ -187,13 +207,18 @@

    Static authTime

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns number

    @@ -210,13 +235,18 @@

    Static email

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -233,12 +263,12 @@

    Static idToken

  • -

    Get decoded id_token from the principal.

    +

    Get decoded id_token from the principal.

    Parameters

    @@ -248,10 +278,20 @@
    principal: object

    user principal

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns object

    the id token

    +
      +
    • +
      [key: string]: any
      +
      • +
    @@ -265,13 +305,18 @@

    Static name

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -288,13 +333,18 @@

    Static nickName

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -311,12 +361,12 @@

    Static parseToken

  • -

    Parse the token string with base64 decoder. +

    Parse the token string with base64 decoder. This will only obtain the "payload" part of the token.

    @@ -331,6 +381,11 @@
    token: string

    Returns object

    token payload json object

    +
      +
    • +
      [key: string]: any
      +
      • +
    • @@ -344,13 +399,18 @@

    Static preferredUsername

    Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -367,12 +427,12 @@

    Static rawAccessToken<
  • -

    Get raw access_token string from the principal.

    +

    Get raw access_token string from the principal.

    Parameters

    @@ -382,6 +442,11 @@
    principal: object

    user principal

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns string

    @@ -399,12 +464,12 @@

    Static rawIdToken

  • -

    Get raw id_token string from the principal.

    +

    Get raw id_token string from the principal.

    Parameters

    @@ -414,6 +479,11 @@
    principal: object

    user principal

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns string

    @@ -431,13 +501,18 @@

    Static sessionState

  • Parameters

    • principal: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -543,6 +618,9 @@

    Returns string
      +
    • + KeycloakRBAC +
    • LinkedInAuth
      • @@ -552,15 +630,24 @@

      Returns string MailchimpAuth +
    • + MicroProfileRBAC +
    • OAuth2Auth
    • OAuth2ClientOptions
      • +
    • + OAuth2RBAC +
    • OAuth2Response
      • +
    • + OpenIDConnectAuth +
    • SalesforceAuth
      • diff --git a/docs/@vertx/redis-client/classes/scanoptions.html b/docs/@vertx/auth-oauth2/classes/keycloakrbac.html similarity index 65% rename from docs/@vertx/redis-client/classes/scanoptions.html rename to docs/@vertx/auth-oauth2/classes/keycloakrbac.html index 8bb21f3e7..70c4afd0b 100644 --- a/docs/@vertx/redis-client/classes/scanoptions.html +++ b/docs/@vertx/auth-oauth2/classes/keycloakrbac.html @@ -3,7 +3,7 @@ - ScanOptions | @vertx/redis-client + KeycloakRBAC | @vertx/auth-oauth2 @@ -22,7 +22,7 @@
    • Preparing search index...
    • The search index is not available

    - @vertx/redis-client + @vertx/auth-oauth2
    @@ -54,10 +54,10 @@ Globals

  • - ScanOptions + KeycloakRBAC
    • -

    Class ScanOptions

    +

    Class KeycloakRBAC

    @@ -68,7 +68,7 @@

    Class ScanOptions

    Hierarchy

    • - ScanOptions + KeycloakRBAC
    @@ -77,36 +77,44 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    count

    -
    count: number
    - -
    -
    - -

    match

    -
    match: string
    - +

    Methods

    +
    + +

    Static create

    + +
      +
    • + +
      +
      +

      Factory method to create a RBAC handler for tokens adhering to the Keycloak token format.

      +
      +
      +

      Parameters

      + +

      Returns OAuth2RBAC

      +

      a RBAC validator

      +
      • +
    @@ -121,109 +129,100 @@

    match

    diff --git a/docs/@vertx/auth-oauth2/classes/linkedinauth.html b/docs/@vertx/auth-oauth2/classes/linkedinauth.html index dd693e379..97018f332 100644 --- a/docs/@vertx/auth-oauth2/classes/linkedinauth.html +++ b/docs/@vertx/auth-oauth2/classes/linkedinauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for LinkedIn

    +

    Create a OAuth2Auth provider for LinkedIn

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for LinkedIn

    +

    Create a OAuth2Auth provider for LinkedIn

    Parameters

    @@ -219,6 +219,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
    • - @vertx/redis-client + @vertx/auth-oauth2
    @@ -54,10 +54,10 @@ Globals
  • - BitFieldGetCommand + MicroProfileRBAC
    • -

    Class BitFieldGetCommand

    +

    Class MicroProfileRBAC

    @@ -68,7 +68,7 @@

    Class BitFieldGetCommand

    Hierarchy

    • - BitFieldGetCommand + MicroProfileRBAC
    @@ -77,36 +77,38 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    offset

    -
    offset: number
    - -
    -
    - -

    type

    -
    type: string
    - +

    Methods

    +
    + +

    Static create

    + +
      +
    • + +
      +
      +

      Factory method to create a RBAC handler for tokens adhering to the MP-JWT 1.1 spec.

      +
      +
      +

      Returns OAuth2RBAC

      +

      a RBAC validator

      +
      • +
    @@ -121,109 +123,100 @@

    type

    diff --git a/docs/@vertx/auth-oauth2/classes/oauth2auth.html b/docs/@vertx/auth-oauth2/classes/oauth2auth.html index 2b5a16565..556e25adf 100644 --- a/docs/@vertx/auth-oauth2/classes/oauth2auth.html +++ b/docs/@vertx/auth-oauth2/classes/oauth2auth.html @@ -68,7 +68,12 @@

    Class OAuth2Auth

    Hierarchy

    • - OAuth2Auth + any +
        +
      • + OAuth2Auth +
        • +
    @@ -84,10 +89,9 @@

    Methods

  • getFlowType
  • getScopeSeparator
  • getToken
    • -
  • hasJWTToken
  • introspectToken
  • loadJWK
    • -
  • verifyIsUsingPassword
    • +
  • rbacHandler
  • create
  • createKeycloak
    • @@ -107,18 +111,23 @@

    authorizeURL

  • -

    Generate a redirect URL to the authN/Z backend. It only applies to auth_code flow.

    +

    Generate a redirect URL to the authN/Z backend. It only applies to auth_code flow.

    Parameters

    • params: object
      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns string

    @@ -135,13 +144,18 @@

    decodeToken

  • -

    Decode a token to a AccessToken object. This is useful to handle bearer JWT tokens.

    +

    Decode a token to a AccessToken object. This is useful to handle bearer JWT tokens.

    +
    +
    deprecated
    +

    use {@link AuthProvider#authenticate(JsonObject, Handler)} instead.

    +
    +

    Parameters

      @@ -159,17 +173,20 @@
      handler: function
        • @@ -191,12 +208,12 @@

        getFlowType

      • -

        Returns the configured flow type for the Oauth2 provider.

        +

        Returns the configured flow type for the Oauth2 provider.

        Returns OAuth2FlowType

        @@ -214,12 +231,12 @@

        getScopeSeparator

      • -

        Returns the scope separator.

        +

        Returns the scope separator.

        The RFC 6749 states that a scope is expressed as a set of case-sensitive and space-delimited strings, however vendors tend not to agree on this and we see the following cases being used: space, plus sign, comma.

        @@ -240,12 +257,12 @@

        getToken

      • -

        Returns the Access Token object.

        +

        Returns the Access Token object.

        deprecated
        @@ -260,6 +277,11 @@
        params: object

        JSON with the options, each flow requires different options.

        +
          +
        • +
          [key: string]: any
          +
          • +
      • handler: function
        @@ -269,17 +291,20 @@
        handler: function
    • -
    - -

    hasJWTToken

    -
      -
    • hasJWTToken(): boolean
      • -
    -
      -
    • - -
      -
      -

      Returns true if this provider supports JWT tokens as the access_token. This is typically true if the provider - implements the openid-connect protocol. This is a plain return from the config option jwtToken, which is false - by default.

      -
      -

      This information is important to validate grants. Since pure OAuth2 should be used for authorization and when a - token is requested all grants should be declared, in case of openid-connect this is not true. OpenId will issue - a token and all grants will be encoded on the token itself so the requester does not need to list the required - grants.

      -
      -

      Returns boolean

      -

      true if openid-connect is used.

      -
      • -
    -

    introspectToken

    @@ -330,12 +326,12 @@

    introspectToken

  • -

    Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine +

    Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.

    @@ -355,17 +351,20 @@
    handler: function
    • @@ -501,18 +512,25 @@

    Static create

    @@ -573,7 +648,7 @@

    Static createKeycloak

  • @@ -600,6 +675,11 @@
    config: object

    the config as exported from the admin console

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns OAuth2Auth

    @@ -661,6 +741,9 @@

    Returns KeycloakHelper +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -670,6 +753,9 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +

    • -

    Properties

    -
    - -

    alpnVersions

    -
    alpnVersions: HttpVersion
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    authorizationPath

    -
    authorizationPath: string
    - -
    -
    -

    Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

    -
    -
    -
    returns
    -

    authorization path

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    clientID

    -
    clientID: string
    - -
    -
    -

    Set the provider client id

    -
    -
    -
    param
    -

    client id

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    clientSecret

    -
    clientSecret: string
    - -
    -
    -

    Set the provider client secret

    -
    -
    -
    param
    -

    client secret

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    clientSecretParameterName

    -
    clientSecretParameterName: string
    - -
    -
    -

    Override the HTTP form field name for client secret

    -
    -
    -
    param
    -

    the new nme

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): OAuth2ClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - +
    + +

    addPubSecKey

    + +
      +
    • + +
      +
      +

      The provider PubSec key options

      +
      +
      +

      Parameters

      +
        +
      • +
        pubSecKeys: PubSecKeyOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      the pub sec key options

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    getAlpnVersions

    +
      +
    • getAlpnVersions(): HttpVersion
      • +
    +
      +
    • + +

      Returns HttpVersion

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    getAuthorizationPath

    +
      +
    • getAuthorizationPath(): string
      • +
    +
      +
    • + +
      +
      +

      Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

      +
      +
      +

      Returns string

      +

      authorization path

      +
      • +
    -
    - -

    decoderInitialBufferSize

    -
    decoderInitialBufferSize: number
    - +
    + +

    getClientID

    +
      +
    • getClientID(): string
      • +
    +
      +
    • + +
      +
      +

      Set the provider client id

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    -
    - -

    defaultHost

    -
    defaultHost: string
    - +
    + +

    getClientSecret

    +
      +
    • getClientSecret(): string
      • +
    +
      +
    • + +
      +
      +

      Set the provider client secret

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    -
    - -

    defaultPort

    -
    defaultPort: number
    - +
    + +

    getClientSecretParameterName

    +
      +
    • getClientSecretParameterName(): string
      • +
    +
      +
    • + +
      +
      +

      Override the HTTP form field name for client secret

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    extraParameters

    -
    extraParameters: object
    - -
    -
    -

    Set extra parameters to be sent to the provider on each request

    -
    -
    -
    param
    -

    a json representation of the parameters

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    forceSni

    -
    forceSni: boolean
    - +
    + +

    getDecoderInitialBufferSize

    +
      +
    • getDecoderInitialBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    headers

    -
    headers: object
    - -
    -
    -

    Set custom headers to be sent with every request to the provider

    -
    -
    -
    param
    -

    the headers

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    getDefaultHost

    +
      +
    • getDefaultHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2ClearTextUpgrade

    -
    http2ClearTextUpgrade: boolean
    - +
    + +

    getDefaultPort

    +
      +
    • getDefaultPort(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    http2ConnectionWindowSize

    -
    http2ConnectionWindowSize: number
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2KeepAliveTimeout

    -
    http2KeepAliveTimeout: number
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2MaxPoolSize

    -
    http2MaxPoolSize: number
    - +
    + +

    getExtraParameters

    +
      +
    • getExtraParameters(): object
      • +
    +
      +
    • + +
      +
      +

      Set extra parameters to be sent to the provider on each request

      +
      +
      +

      Returns object

      +

      self

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    http2MultiplexingLimit

    -
    http2MultiplexingLimit: number
    - +
    + +

    getFlow

    + +
      +
    • + +

      Returns OAuth2FlowType

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getHeaders

    +
      +
    • getHeaders(): object
      • +
    +
      +
    • + +
      +
      +

      Set custom headers to be sent with every request to the provider

      +
      +
      +

      Returns object

      +

      self

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    initialSettings

    -
    initialSettings: Http2Settings
    - +
    + +

    getHttp2ConnectionWindowSize

    +
      +
    • getHttp2ConnectionWindowSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    introspectionPath

    -
    introspectionPath: string
    - -
    -
    -

    Set the provider token introspection resource path

    -
    -
    -
    param
    -

    a resource path

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    getHttp2KeepAliveTimeout

    +
      +
    • getHttp2KeepAliveTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getHttp2MaxPoolSize

    +
      +
    • getHttp2MaxPoolSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    jwkPath

    -
    jwkPath: string
    - +
    + +

    getHttp2MultiplexingLimit

    +
      +
    • getHttp2MultiplexingLimit(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    jwtOptions

    -
    jwtOptions: JWTOptions
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    jwtToken

    -
    jwtToken: boolean
    - +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    keepAlive

    -
    keepAlive: boolean
    - +
    + +

    getInitialSettings

    +
      +
    • getInitialSettings(): Http2Settings
      • +
    +
      +
    • + +

      Returns Http2Settings

      +
      • +
    -
    - -

    keepAliveTimeout

    -
    keepAliveTimeout: number
    - +
    + +

    getIntrospectionPath

    +
      +
    • getIntrospectionPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the provider token introspection resource path

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getJWTOptions

    +
      +
    • getJWTOptions(): JWTOptions
      • +
    +
      +
    • + +

      Returns JWTOptions

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getJwkPath

    +
      +
    • getJwkPath(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    logoutPath

    -
    logoutPath: string
    - -
    -
    -

    Set the provider logout path

    -
    -
    -
    param
    -

    a logout resource path

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    getKeepAliveTimeout

    +
      +
    • getKeepAliveTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxChunkSize

    -
    maxChunkSize: number
    - +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    maxHeaderSize

    -
    maxHeaderSize: number
    - +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    maxInitialLineLength

    -
    maxInitialLineLength: number
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    maxPoolSize

    -
    maxPoolSize: number
    - +
    + +

    getLogoutPath

    +
      +
    • getLogoutPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the provider logout path

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    -
    - -

    maxRedirects

    -
    maxRedirects: number
    - +
    + +

    getMaxChunkSize

    +
      +
    • getMaxChunkSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWaitQueueSize

    -
    maxWaitQueueSize: number
    - +
    + +

    getMaxHeaderSize

    +
      +
    • getMaxHeaderSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWebsocketFrameSize

    -
    maxWebsocketFrameSize: number
    - +
    + +

    getMaxInitialLineLength

    +
      +
    • getMaxInitialLineLength(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWebsocketMessageSize

    -
    maxWebsocketMessageSize: number
    - +
    + +

    getMaxPoolSize

    +
      +
    • getMaxPoolSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - +
    + +

    getMaxRedirects

    +
      +
    • getMaxRedirects(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getMaxWaitQueueSize

    +
      +
    • getMaxWaitQueueSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getMaxWebsocketFrameSize

    +
      +
    • getMaxWebsocketFrameSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getMaxWebsocketMessageSize

    +
      +
    • getMaxWebsocketMessageSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPipeliningLimit

    +
      +
    • getPipeliningLimit(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getPoolCleanerPeriod

    +
      +
    • getPoolCleanerPeriod(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getProtocolVersion

    +
      +
    • getProtocolVersion(): HttpVersion
      • +
    +
      +
    • + +

      Returns HttpVersion

      +
      • +
    +
    +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +

      Returns ProxyOptions

      +
      • +
    +
    +
    + +

    getPubSecKeys

    +
      +
    • getPubSecKeys(): PubSecKeyOptions
      • +
    +
      +
    • + +
      +
      +

      The provider PubSec key options

      +
      +
      +

      Returns PubSecKeyOptions

      +

      the pub sec key options

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getRevocationPath

    +
      +
    • getRevocationPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    +
    +
    + +

    getScopeSeparator

    +
      +
    • getScopeSeparator(): string
      • +
    +
      +
    • + +
      +
      +

      Set the provider scope separator

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSite

    +
      +
    • getSite(): string
      • +
    +
      +
    • + +
      +
      +

      Root URL for the provider

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTokenPath

    +
      +
    • getTokenPath(): string
      • +
    +
      +
    • + +
      +
      +

      Get the Oauth2 token resource path. e.g.: /oauth/token

      +
      +
      +

      Returns string

      +

      token path

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getUserAgent

    +
      +
    • getUserAgent(): string
      • +
    +
      +
    • + +
      +
      +

      Set a custom user agent to use when communicating to a provider

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    +
    +
    + +

    getUserInfoParameters

    +
      +
    • getUserInfoParameters(): object
      • +
    +
      +
    • + +
      +
      +

      Set custom parameters to be sent during the userInfo resource request

      +
      +
      +

      Returns object

      +

      self

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    getUserInfoPath

    +
      +
    • getUserInfoPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the provider userInfo resource path

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    +
    +
    + +

    getWebsocketCompressionAllowClientNoContext

    +
      +
    • getWebsocketCompressionAllowClientNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getWebsocketCompressionLevel

    +
      +
    • getWebsocketCompressionLevel(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getWebsocketCompressionRequestServerNoContext

    +
      +
    • getWebsocketCompressionRequestServerNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isForceSni

    +
      +
    • isForceSni(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isHttp2ClearTextUpgrade

    +
      +
    • isHttp2ClearTextUpgrade(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isKeepAlive

    +
      +
    • isKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isPipelining

    +
      +
    • isPipelining(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSendUnmaskedFrames

    +
      +
    • isSendUnmaskedFrames(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTryUseCompression

    +
      +
    • isTryUseCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseBasicAuthorizationHeader

    +
      +
    • isUseBasicAuthorizationHeader(): boolean
      • +
    +
      +
    • + +
      +
      +

      Flag to use HTTP basic auth header with client id, client secret.

      +
      +
      +

      Returns boolean

      +

      self

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isValidateIssuer

    +
      +
    • isValidateIssuer(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isVerifyHost

    +
      +
    • isVerifyHost(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAlpnVersions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        alpnVersions: HttpVersion
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setAuthorizationPath

    + +
      +
    • + +
      +
      +

      Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

      +
      +
      +

      Parameters

      +
        +
      • +
        authorizationPath: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      authorization path

      +
      • +
    +
    +
    + +

    setClientID

    + +
      +
    • + +
      +
      +

      Set the provider client id

      +
      +
      +

      Parameters

      +
        +
      • +
        clientID: string
        +
        +

        client id

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setClientSecret

    + +
      +
    • + +
      +
      +

      Set the provider client secret

      +
      +
      +

      Parameters

      +
        +
      • +
        clientSecret: string
        +
        +

        client secret

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setClientSecretParameterName

    + +
      +
    • + +
      +
      +

      Override the HTTP form field name for client secret

      +
      +
      +

      Parameters

      +
        +
      • +
        clientSecretParameterName: string
        +
        +

        the new nme

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setDecoderInitialBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        decoderInitialBufferSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setDefaultHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        defaultHost: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setDefaultPort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        defaultPort: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): OAuth2ClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setExtraParameters

    + +
      +
    • + +
      +
      +

      Set extra parameters to be sent to the provider on each request

      +
      +
      +

      Parameters

      +
        +
      • +
        extraParameters: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setFlow

    + + +
    +
    + +

    setForceSni

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        forceSni: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setHeaders

    + +
      +
    • + +
      +
      +

      Set custom headers to be sent with every request to the provider

      +
      +
      +

      Parameters

      +
        +
      • +
        headers: object
        +
        +

        the headers

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setHttp2ClearTextUpgrade

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2ClearTextUpgrade: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setHttp2ConnectionWindowSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2ConnectionWindowSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setHttp2KeepAliveTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2KeepAliveTimeout: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setHttp2MaxPoolSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2MaxPoolSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setHttp2MultiplexingLimit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2MultiplexingLimit: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setInitialSettings

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        initialSettings: Http2Settings
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setIntrospectionPath

    + +
      +
    • + +
      +
      +

      Set the provider token introspection resource path

      +
      +
      +

      Parameters

      +
        +
      • +
        introspectionPath: string
        +
        +

        a resource path

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    -
    - -

    pipelining

    -
    pipelining: boolean
    - +
    + +

    setJWTOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        jwtOptions: JWTOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    pipeliningLimit

    -
    pipeliningLimit: number
    - +
    + +

    setJdkSslEngineOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    poolCleanerPeriod

    -
    poolCleanerPeriod: number
    - +
    + +

    setJwkPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        jwkPath: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    protocolVersion

    -
    protocolVersion: HttpVersion
    - +
    + +

    setKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keepAlive: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - +
    + +

    setKeepAliveTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keepAliveTimeout: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    pubSecKeys

    -
    pubSecKeys: PubSecKeyOptions
    - -
    -
    -

    The provider PubSec key options

    -
    -
    -
    returns
    -

    the pub sec key options

    -
    -
    -
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setLocalAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setLogoutPath

    + +
      +
    • + +
      +
      +

      Set the provider logout path

      +
      +
      +

      Parameters

      +
        +
      • +
        logoutPath: string
        +
        +

        a logout resource path

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    -
    - -

    revocationPath

    -
    revocationPath: string
    - -
    -
    -

    Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

    -
    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setMaxChunkSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxChunkSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    scopeSeparator

    -
    scopeSeparator: string
    - -
    -
    -

    Set the provider scope separator

    -
    -
    -
    param
    -

    a separator e.g.: ' ', '+', ','

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setMaxHeaderSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxHeaderSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMaxInitialLineLength

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxInitialLineLength: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMaxPoolSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxPoolSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMaxRedirects

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxRedirects: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMaxWaitQueueSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWaitQueueSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMaxWebsocketFrameSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWebsocketFrameSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMaxWebsocketMessageSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWebsocketMessageSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setMetricsName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPipelining

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pipelining: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPipeliningLimit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pipeliningLimit: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPoolCleanerPeriod

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        poolCleanerPeriod: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setProtocolVersion

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        protocolVersion: HttpVersion
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setProxyOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setPubSecKeys

    + +
      +
    • + +
      +
      +

      The provider PubSec key options

      +
      +
      +

      Parameters

      +
        +
      • +
        pubSecKeys: PubSecKeyOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      the pub sec key options

      +
      • +
    +
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setRevocationPath

    + +
      +
    • + +
      +
      +

      Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

      +
      +
      +

      Parameters

      +
        +
      • +
        revocationPath: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setScopeSeparator

    + +
      +
    • + +
      +
      +

      Set the provider scope separator

      +
      +
      +

      Parameters

      +
        +
      • +
        scopeSeparator: string
        +
        +

        a separator e.g.: ' ', '+', ','

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setSendUnmaskedFrames

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendUnmaskedFrames: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setSite

    + +
      +
    • + +
      +
      +

      Root URL for the provider

      +
      +
      +

      Parameters

      +
        +
      • +
        site: string
        +
        +

        a url

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    +
    +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    +
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    sendUnmaskedFrames

    -
    sendUnmaskedFrames: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    site

    -
    site: string
    - -
    -
    -

    Root URL for the provider

    -
    -
    -
    param
    -

    a url

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setTokenPath

    + +
      +
    • + +
      +
      +

      Get the Oauth2 token resource path. e.g.: /oauth/token

      +
      +
      +

      Parameters

      +
        +
      • +
        tokenPath: string
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      token path

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setTrustAll

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTryUseCompression

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUseCompression: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTryUsePerFrameWebsocketCompression

    +
      +
    • setTryUsePerFrameWebsocketCompression(tryUsePerFrameWebsocketCompression: boolean): OAuth2ClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUsePerFrameWebsocketCompression: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTryUsePerMessageWebsocketCompression

    +
      +
    • setTryUsePerMessageWebsocketCompression(tryUsePerMessageWebsocketCompression: boolean): OAuth2ClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUsePerMessageWebsocketCompression: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    tokenPath

    -
    tokenPath: string
    - -
    -
    -

    Get the Oauth2 token resource path. e.g.: /oauth/token

    -
    -
    -
    returns
    -

    token path

    -
    -
    -
    +
    + +

    setUseBasicAuthorizationHeader

    +
      +
    • setUseBasicAuthorizationHeader(useBasicAuthorizationHeader: boolean): OAuth2ClientOptions
      • +
    +
      +
    • + +
      +
      +

      Flag to use HTTP basic auth header with client id, client secret.

      +
      +
      +

      Parameters

      +
        +
      • +
        useBasicAuthorizationHeader: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - +
    + +

    setUserAgent

    + +
      +
    • + +
      +
      +

      Set a custom user agent to use when communicating to a provider

      +
      +
      +

      Parameters

      +
        +
      • +
        userAgent: string
        +
        +

        the user agent

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setUserInfoParameters

    + +
      +
    • + +
      +
      +

      Set custom parameters to be sent during the userInfo resource request

      +
      +
      +

      Parameters

      +
        +
      • +
        userInfoParameters: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    -
    - -

    tryUseCompression

    -
    tryUseCompression: boolean
    - +
    + +

    setUserInfoPath

    + +
      +
    • + +
      +
      +

      Set the provider userInfo resource path

      +
      +
      +

      Parameters

      +
        +
      • +
        userInfoPath: string
        +
        +

        a resource path

        +
        +
        • +
      +

      Returns OAuth2ClientOptions

      +

      self

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setValidateIssuer

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        validateIssuer: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    useBasicAuthorizationHeader

    -
    useBasicAuthorizationHeader: boolean
    - -
    -
    -

    Flag to use HTTP basic auth header with client id, client secret.

    -
    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setVerifyHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        verifyHost: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setWebsocketCompressionAllowClientNoContext

    +
      +
    • setWebsocketCompressionAllowClientNoContext(websocketCompressionAllowClientNoContext: boolean): OAuth2ClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionAllowClientNoContext: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    userAgent

    -
    userAgent: string
    - -
    -
    -

    Set a custom user agent to use when communicating to a provider

    -
    -
    -
    param
    -

    the user agent

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setWebsocketCompressionLevel

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionLevel: number
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    userInfoParameters

    -
    userInfoParameters: object
    - -
    -
    -

    Set custom parameters to be sent during the userInfo resource request

    -
    -
    -
    param
    -

    json representation of the parameters

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setWebsocketCompressionRequestServerNoContext

    +
      +
    • setWebsocketCompressionRequestServerNoContext(websocketCompressionRequestServerNoContext: boolean): OAuth2ClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionRequestServerNoContext: boolean
        +
        • +
      +

      Returns OAuth2ClientOptions

      +
      • +
    -
    - -

    userInfoPath

    -
    userInfoPath: string
    - -
    -
    -

    Set the provider userInfo resource path

    -
    -
    -
    param
    -

    a resource path

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    tryUsePerFrameWebsocketCompression

    +
      +
    • tryUsePerFrameWebsocketCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    verifyHost

    -
    verifyHost: boolean
    - +
    + +

    tryUsePerMessageWebsocketCompression

    +
      +
    • tryUsePerMessageWebsocketCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    @@ -1237,6 +4195,9 @@

    verifyHost

  • KeycloakHelper
    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -1246,6 +4207,9 @@

    verifyHost

  • MailchimpAuth
    • +
  • + MicroProfileRBAC +
  • OAuth2Auth
    • @@ -1254,256 +4218,556 @@

    verifyHost

  • OAuth2ClientOptions
      • +
    • + OAuth2RBAC +
    • OAuth2Response
      • +
    • + OpenIDConnectAuth +
    • SalesforceAuth
      • diff --git a/docs/@vertx/auth-oauth2/classes/oauth2rbac.html b/docs/@vertx/auth-oauth2/classes/oauth2rbac.html new file mode 100644 index 000000000..a855c4b91 --- /dev/null +++ b/docs/@vertx/auth-oauth2/classes/oauth2rbac.html @@ -0,0 +1,335 @@ + + + + + + OAuth2RBAC | @vertx/auth-oauth2 + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
        • +
      • Public/Protected
        • +
      • All
        • +
      +
      + + + + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Class OAuth2RBAC

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • + OAuth2RBAC +
        • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Methods

      + +
      +
      +
      +
      +
      +

      Methods

      +
      + +

      isAuthorized

      +
        +
      • isAuthorized(user: AccessToken, authority: string, handler: function): void
        • +
      +
        +
      • + +
        +
        +

        This method should verify if the user has the given authority and return either a boolean value or an error.

        +
        +

        Note that false and errors are not the same. A user might not have a given authority but that doesn't mean that + there was an error during the call.

        +
        +

        Parameters

        +
          +
        • +
          user: AccessToken
          +
          +

          the given user to assert on

          +
          +
          • +
        • +
          authority: string
          +
          +

          the authority to lookup

          +
          +
          • +
        • +
          handler: function
          +
          +

          the result handler.

          +
          +
            +
          • +
              +
            • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>
              • +
            +
              +
            • +

              Parameters

              +
                +
              • +
                res: AsyncResult<boolean>
                +
                • +
              +

              Returns void + | + Handler<AsyncResult<boolean>> +

              +
              • +
            +
            • +
          +
          • +
        +

        Returns void

        +
        • +
      +
      +
      +
      +
      + + +
      +
      +
      +
      +
      +

      Legend

      +
      +
        +
      • Module
        • +
      • Object literal
        • +
      • Variable
        • +
      • Function
        • +
      • Function with type parameter
        • +
      • Index signature
        • +
      • Type alias
        • +
      +
        +
      • Enumeration
        • +
      • Enumeration member
        • +
      • Property
        • +
      • Method
        • +
      +
        +
      • Interface
        • +
      • Interface with type parameter
        • +
      • Constructor
        • +
      • Property
        • +
      • Method
        • +
      • Index signature
        • +
      +
        +
      • Class
        • +
      • Class with type parameter
        • +
      • Constructor
        • +
      • Property
        • +
      • Method
        • +
      • Accessor
        • +
      • Index signature
        • +
      +
        +
      • Inherited constructor
        • +
      • Inherited property
        • +
      • Inherited method
        • +
      • Inherited accessor
        • +
      +
        +
      • Protected property
        • +
      • Protected method
        • +
      • Protected accessor
        • +
      +
        +
      • Private property
        • +
      • Private method
        • +
      • Private accessor
        • +
      +
        +
      • Static property
        • +
      • Static method
        • +
      +
      +
      +
      +
      +

      Generated using TypeDoc

      +
      +
      + + + + \ No newline at end of file diff --git a/docs/@vertx/auth-oauth2/classes/oauth2response.html b/docs/@vertx/auth-oauth2/classes/oauth2response.html index 54633e502..0316f2ef1 100644 --- a/docs/@vertx/auth-oauth2/classes/oauth2response.html +++ b/docs/@vertx/auth-oauth2/classes/oauth2response.html @@ -103,12 +103,12 @@

      body

    • -

      The HTTP response body as a buffer

      +

      The HTTP response body as a buffer

      Returns Buffer @@ -129,12 +129,12 @@

      getHeader

    • -

      Looks up a HTTP response header by name, in case where the response is a list of headers, +

      Looks up a HTTP response header by name, in case where the response is a list of headers, the first one is returned.

      @@ -162,12 +162,12 @@

      headers

    • -

      The HTTP response headers from the HTTP layer.

      +

      The HTTP response headers from the HTTP layer.

      Returns MultiMap @@ -188,12 +188,12 @@

      is

    • -

      Helper to analize the response body. The test is performed against the header Content-Type, +

      Helper to analize the response body. The test is performed against the header Content-Type, the content of the body is not analyzed.

      @@ -221,12 +221,12 @@

      jsonArray

    • -

      The HTTP response body as a JsonArray

      +

      The HTTP response body as a JsonArray

      Returns any[] @@ -241,21 +241,21 @@

      Returns any

      jsonObject

        -
      • jsonObject(): any | null
        • +
      • jsonObject(): object | null
      • -

        The HTTP response body as a JsonObject

        +

        The HTTP response body as a JsonObject

        -

        Returns any +

        Returns object | null

        @@ -273,12 +273,12 @@

        statusCode

      • -

        the returned status code from the HTTP layer.

        +

        the returned status code from the HTTP layer.

        Returns number

        @@ -340,6 +340,9 @@

        Returns number KeycloakHelper

        • +
      • + KeycloakRBAC +
      • LinkedInAuth
        • @@ -349,12 +352,18 @@

        Returns number MailchimpAuth +
      • + MicroProfileRBAC +
      • OAuth2Auth
      • OAuth2ClientOptions
        • +
      • + OAuth2RBAC +

      • @@ -385,6 +394,9 @@

        Returns number

        +
      • + OpenIDConnectAuth +
      • SalesforceAuth
        • diff --git a/docs/@vertx/auth-oauth2/classes/openidconnectauth.html b/docs/@vertx/auth-oauth2/classes/openidconnectauth.html new file mode 100644 index 000000000..3f6848de5 --- /dev/null +++ b/docs/@vertx/auth-oauth2/classes/openidconnectauth.html @@ -0,0 +1,350 @@ + + + + + + OpenIDConnectAuth | @vertx/auth-oauth2 + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
          • +
        • Public/Protected
          • +
        • All
          • +
        +
        + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Class OpenIDConnectAuth

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        + +
        +
        +

        Index

        +
        +
        +
        +

        Methods

        + +
        +
        +
        +
        +
        +

        Methods

        +
        + +

        Static discover

        + +
          +
        • + +
          +
          +

          Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the given site in the + configuration options and attempt to load the well known descriptor.

          +
          +

          If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded + into the OAuth provider so tokens can be decoded.

          +
          +

          Parameters

          +
            +
          • +
            vertx: Vertx
            +
            +

            the vertx instance

            +
            +
            • +
          • +
            config: OAuth2ClientOptions
            +
            +

            the initial config, it should contain a site url

            +
            +
            • +
          • +
            handler: function
            +
            +

            the instantiated Oauth2 provider instance handler

            +
            +
              +
            • + +
                +
              • +

                Parameters

                + +

                Returns void + | + Handler<AsyncResult<OAuth2Auth>> +

                +
                • +
              +
              • +
            +
            • +
          +

          Returns void

          +
          • +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
          • +
        • Object literal
          • +
        • Variable
          • +
        • Function
          • +
        • Function with type parameter
          • +
        • Index signature
          • +
        • Type alias
          • +
        +
          +
        • Enumeration
          • +
        • Enumeration member
          • +
        • Property
          • +
        • Method
          • +
        +
          +
        • Interface
          • +
        • Interface with type parameter
          • +
        • Constructor
          • +
        • Property
          • +
        • Method
          • +
        • Index signature
          • +
        +
          +
        • Class
          • +
        • Class with type parameter
          • +
        • Constructor
          • +
        • Property
          • +
        • Method
          • +
        • Accessor
          • +
        • Index signature
          • +
        +
          +
        • Inherited constructor
          • +
        • Inherited property
          • +
        • Inherited method
          • +
        • Inherited accessor
          • +
        +
          +
        • Protected property
          • +
        • Protected method
          • +
        • Protected accessor
          • +
        +
          +
        • Private property
          • +
        • Private method
          • +
        • Private accessor
          • +
        +
          +
        • Static property
          • +
        • Static method
          • +
        +
        +
        +
        +
        +

        Generated using TypeDoc

        +
        +
        + + + + \ No newline at end of file diff --git a/docs/@vertx/auth-oauth2/classes/salesforceauth.html b/docs/@vertx/auth-oauth2/classes/salesforceauth.html index 4dca512f7..0e0878300 100644 --- a/docs/@vertx/auth-oauth2/classes/salesforceauth.html +++ b/docs/@vertx/auth-oauth2/classes/salesforceauth.html @@ -68,7 +68,12 @@

        Class SalesforceAuth

        Hierarchy

    @@ -80,6 +85,7 @@

    Index

    Methods

    @@ -98,12 +104,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Salesforce

    +

    Create a OAuth2Auth provider for Salesforce

    Parameters

    @@ -129,12 +135,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Salesforce

    +

    Create a OAuth2Auth provider for Salesforce

    Parameters

    @@ -165,6 +171,76 @@

    Returns + +

    Static discover

    + +
      +
    • + +
      +
      +

      Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the + configuration options and attempt to load the well known descriptor. If a site is provided (for example when + running on a custom instance) that site will be used to do the lookup. +

      + If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded + into the OAuth provider so tokens can be decoded.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        +

        the vertx instance

        +
        +
        • +
      • +
        config: OAuth2ClientOptions
        +
        +

        the initial config

        +
        +
        • +
      • +
        handler: function
        +
        +

        the instantiated Oauth2 provider instance handler

        +
        +
          +
        • + +
            +
          • +

            Parameters

            + +

            Returns void + | + Handler<AsyncResult<OAuth2Auth>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns void

      +
      • +
    +

    • @@ -219,6 +295,9 @@

    Returns KeycloakHelper +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -228,15 +307,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
    • diff --git a/docs/@vertx/auth-oauth2/classes/shopifyauth.html b/docs/@vertx/auth-oauth2/classes/shopifyauth.html index d3351c57f..9c00d2bbd 100644 --- a/docs/@vertx/auth-oauth2/classes/shopifyauth.html +++ b/docs/@vertx/auth-oauth2/classes/shopifyauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Shopify

    +

    Create a OAuth2Auth provider for Shopify

    Parameters

    @@ -135,12 +135,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Shopify

    +

    Create a OAuth2Auth provider for Shopify

    Parameters

    @@ -231,6 +231,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -240,15 +243,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/soundcloudauth.html b/docs/@vertx/auth-oauth2/classes/soundcloudauth.html index 0b8543476..bae57ac9e 100644 --- a/docs/@vertx/auth-oauth2/classes/soundcloudauth.html +++ b/docs/@vertx/auth-oauth2/classes/soundcloudauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for SoundCloud

    +

    Create a OAuth2Auth provider for SoundCloud

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for SoundCloud

    +

    Create a OAuth2Auth provider for SoundCloud

    Parameters

    @@ -219,6 +219,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -228,15 +231,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/stripeauth.html b/docs/@vertx/auth-oauth2/classes/stripeauth.html index 91512966f..ed14984a5 100644 --- a/docs/@vertx/auth-oauth2/classes/stripeauth.html +++ b/docs/@vertx/auth-oauth2/classes/stripeauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Stripe

    +

    Create a OAuth2Auth provider for Stripe

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Stripe

    +

    Create a OAuth2Auth provider for Stripe

    Parameters

    @@ -219,6 +219,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -228,15 +231,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/classes/twitterauth.html b/docs/@vertx/auth-oauth2/classes/twitterauth.html index 1d85f1601..42e6568e1 100644 --- a/docs/@vertx/auth-oauth2/classes/twitterauth.html +++ b/docs/@vertx/auth-oauth2/classes/twitterauth.html @@ -98,12 +98,12 @@

    Static create

  • -

    Create a OAuth2Auth provider for Twitter

    +

    Create a OAuth2Auth provider for Twitter

    Parameters

    @@ -129,12 +129,12 @@

    Returns
    -

    Create a OAuth2Auth provider for Twitter

    +

    Create a OAuth2Auth provider for Twitter

    Parameters

    @@ -219,6 +219,9 @@

    Returns KeycloakHelper

    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -228,15 +231,24 @@

    Returns MailchimpAuth +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/enums/oauth2flowtype.html b/docs/@vertx/auth-oauth2/enums/oauth2flowtype.html index 3c494df38..982c82665 100644 --- a/docs/@vertx/auth-oauth2/enums/oauth2flowtype.html +++ b/docs/@vertx/auth-oauth2/enums/oauth2flowtype.html @@ -194,6 +194,9 @@

    PASSWORD

  • KeycloakHelper
    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -203,15 +206,24 @@

    PASSWORD

  • MailchimpAuth
    • +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/globals.html b/docs/@vertx/auth-oauth2/globals.html index ce5684df6..93ed3298f 100644 --- a/docs/@vertx/auth-oauth2/globals.html +++ b/docs/@vertx/auth-oauth2/globals.html @@ -87,12 +87,16 @@

    Classes

  • InstagramAuth
  • KeycloakAuth
  • KeycloakHelper
    • +
  • KeycloakRBAC
  • LinkedInAuth
  • LiveAuth
  • MailchimpAuth
    • +
  • MicroProfileRBAC
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • OAuth2RBAC
  • OAuth2Response
    • +
  • OpenIDConnectAuth
  • SalesforceAuth
  • ShopifyAuth
  • SoundcloudAuth
    • @@ -156,6 +160,9 @@

    Classes

  • KeycloakHelper
    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -165,15 +172,24 @@

    Classes

  • MailchimpAuth
    • +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-oauth2/index.html b/docs/@vertx/auth-oauth2/index.html index b352867d2..bfa2533d0 100644 --- a/docs/@vertx/auth-oauth2/index.html +++ b/docs/@vertx/auth-oauth2/index.html @@ -149,6 +149,9 @@
  • KeycloakHelper
    • +
  • + KeycloakRBAC +
  • LinkedInAuth
    • @@ -158,15 +161,24 @@
  • MailchimpAuth
    • +
  • + MicroProfileRBAC +
  • OAuth2Auth
  • OAuth2ClientOptions
    • +
  • + OAuth2RBAC +
  • OAuth2Response
    • +
  • + OpenIDConnectAuth +
  • SalesforceAuth
    • diff --git a/docs/@vertx/auth-shiro/assets/js/search.js b/docs/@vertx/auth-shiro/assets/js/search.js index 8ba58d10a..33b1fac30 100644 --- a/docs/@vertx/auth-shiro/assets/js/search.js +++ b/docs/@vertx/auth-shiro/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"ShiroAuthRealmType","url":"enums/shiroauthrealmtype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"PROPERTIES","url":"enums/shiroauthrealmtype.html#properties","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ShiroAuthRealmType"},{"id":2,"kind":16,"name":"LDAP","url":"enums/shiroauthrealmtype.html#ldap","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ShiroAuthRealmType"},{"id":3,"kind":128,"name":"ShiroAuthOptions","url":"classes/shiroauthoptions.html","classes":"tsd-kind-class"},{"id":4,"kind":1024,"name":"config","url":"classes/shiroauthoptions.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":5,"kind":1024,"name":"type","url":"classes/shiroauthoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":6,"kind":128,"name":"ShiroAuth","url":"classes/shiroauth.html","classes":"tsd-kind-class"},{"id":7,"kind":2048,"name":"create","url":"classes/shiroauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShiroAuth"},{"id":8,"kind":2048,"name":"setRolePrefix","url":"classes/shiroauth.html#setroleprefix","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShiroAuth"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"ShiroAuthRealmType","url":"enums/shiroauthrealmtype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"PROPERTIES","url":"enums/shiroauthrealmtype.html#properties","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ShiroAuthRealmType"},{"id":2,"kind":16,"name":"LDAP","url":"enums/shiroauthrealmtype.html#ldap","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ShiroAuthRealmType"},{"id":3,"kind":128,"name":"ShiroAuthOptions","url":"classes/shiroauthoptions.html","classes":"tsd-kind-class"},{"id":4,"kind":512,"name":"constructor","url":"classes/shiroauthoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":5,"kind":2048,"name":"getConfig","url":"classes/shiroauthoptions.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":6,"kind":2048,"name":"setConfig","url":"classes/shiroauthoptions.html#setconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":7,"kind":2048,"name":"getType","url":"classes/shiroauthoptions.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":8,"kind":2048,"name":"setType","url":"classes/shiroauthoptions.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShiroAuthOptions"},{"id":9,"kind":128,"name":"ShiroAuth","url":"classes/shiroauth.html","classes":"tsd-kind-class"},{"id":10,"kind":2048,"name":"create","url":"classes/shiroauth.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShiroAuth"},{"id":11,"kind":2048,"name":"setRolePrefix","url":"classes/shiroauth.html#setroleprefix","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShiroAuth"}]}; \ No newline at end of file diff --git a/docs/@vertx/auth-shiro/classes/shiroauth.html b/docs/@vertx/auth-shiro/classes/shiroauth.html index fa8991312..3559b7d64 100644 --- a/docs/@vertx/auth-shiro/classes/shiroauth.html +++ b/docs/@vertx/auth-shiro/classes/shiroauth.html @@ -68,7 +68,12 @@

    Class ShiroAuth

    Hierarchy

    • - ShiroAuth + any +
        +
      • + ShiroAuth +
        • +
    @@ -98,12 +103,12 @@

    setRolePrefix

  • -

    Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    +

    Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    Parameters

    @@ -131,12 +136,12 @@

    Static create

  • -

    Create a Shiro auth provider

    +

    Create a Shiro auth provider

    deprecated
    @@ -163,6 +168,11 @@
    config: object

    the config

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns ShiroAuth

    @@ -171,12 +181,12 @@

    Returns
    -

    Create a Shiro auth provider

    +

    Create a Shiro auth provider

    Parameters

    diff --git a/docs/@vertx/auth-shiro/classes/shiroauthoptions.html b/docs/@vertx/auth-shiro/classes/shiroauthoptions.html index a12c19cce..d42b77335 100644 --- a/docs/@vertx/auth-shiro/classes/shiroauthoptions.html +++ b/docs/@vertx/auth-shiro/classes/shiroauthoptions.html @@ -77,62 +77,179 @@

    Index

    -

    Properties

    +

    Constructors

     +
    +
    +

    Methods

    +

    -

    Properties

    -
    - -

    config

    -
    config: object
    - -
    -
    -

    Set the Shiro auth config.

    -
    -
    -
    param
    -

    the config

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    type

    -
    type: ShiroAuthRealmType
    - -
    -
    -

    Set the Shiro auth options type.

    -
    -
    -
    param
    -

    the type

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getConfig

    +
      +
    • getConfig(): object
      • +
    +
      +
    • + +
      +
      +

      Set the Shiro auth config.

      +
      +
      +

      Returns object

      +

      a reference to this, so the API can be used fluently

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    getType

    + +
      +
    • + +
      +
      +

      Set the Shiro auth options type.

      +
      +
      +

      Returns ShiroAuthRealmType

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConfig

    + +
      +
    • + +
      +
      +

      Set the Shiro auth config.

      +
      +
      +

      Parameters

      +
        +
      • +
        config: object
        +
        +

        the config

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns ShiroAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +
      +
      +

      Set the Shiro auth options type.

      +
      +
      +

      Parameters

      + +

      Returns ShiroAuthOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -157,11 +274,20 @@

    type

  • ShiroAuthOptions
    • diff --git a/docs/@vertx/auth-shiro/enums/shiroauthrealmtype.html b/docs/@vertx/auth-shiro/enums/shiroauthrealmtype.html index 56312a247..3a5687118 100644 --- a/docs/@vertx/auth-shiro/enums/shiroauthrealmtype.html +++ b/docs/@vertx/auth-shiro/enums/shiroauthrealmtype.html @@ -86,7 +86,7 @@

    LDAP

    LDAP:
    @@ -96,7 +96,7 @@

    PROPERTIES

    PROPERTIES:
    diff --git a/docs/@vertx/bridge-common/assets/js/search.js b/docs/@vertx/bridge-common/assets/js/search.js index f44146802..a00f38dbc 100644 --- a/docs/@vertx/bridge-common/assets/js/search.js +++ b/docs/@vertx/bridge-common/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"BridgeEventType","url":"enums/bridgeeventtype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"SOCKET_CREATED","url":"enums/bridgeeventtype.html#socket_created","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":2,"kind":16,"name":"SOCKET_CLOSED","url":"enums/bridgeeventtype.html#socket_closed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":3,"kind":16,"name":"SOCKET_IDLE","url":"enums/bridgeeventtype.html#socket_idle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":4,"kind":16,"name":"SOCKET_PING","url":"enums/bridgeeventtype.html#socket_ping","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":5,"kind":16,"name":"SEND","url":"enums/bridgeeventtype.html#send","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":6,"kind":16,"name":"PUBLISH","url":"enums/bridgeeventtype.html#publish","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":7,"kind":16,"name":"RECEIVE","url":"enums/bridgeeventtype.html#receive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":8,"kind":16,"name":"REGISTER","url":"enums/bridgeeventtype.html#register","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":9,"kind":16,"name":"UNREGISTER","url":"enums/bridgeeventtype.html#unregister","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":10,"kind":128,"name":"BaseBridgeEvent","url":"classes/basebridgeevent.html","classes":"tsd-kind-class"},{"id":11,"kind":2048,"name":"setHandler","url":"classes/basebridgeevent.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":12,"kind":2048,"name":"complete","url":"classes/basebridgeevent.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":13,"kind":2048,"name":"tryComplete","url":"classes/basebridgeevent.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":14,"kind":2048,"name":"result","url":"classes/basebridgeevent.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":15,"kind":2048,"name":"compose","url":"classes/basebridgeevent.html#compose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":16,"kind":2048,"name":"map","url":"classes/basebridgeevent.html#map","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":17,"kind":2048,"name":"completer","url":"classes/basebridgeevent.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":18,"kind":2048,"name":"recover","url":"classes/basebridgeevent.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":19,"kind":2048,"name":"otherwise","url":"classes/basebridgeevent.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":20,"kind":2048,"name":"otherwiseEmpty","url":"classes/basebridgeevent.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":21,"kind":2048,"name":"type","url":"classes/basebridgeevent.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":22,"kind":2048,"name":"getRawMessage","url":"classes/basebridgeevent.html#getrawmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":23,"kind":2048,"name":"setRawMessage","url":"classes/basebridgeevent.html#setrawmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":24,"kind":128,"name":"BridgeOptions","url":"classes/bridgeoptions.html","classes":"tsd-kind-class"},{"id":25,"kind":1024,"name":"inboundPermitteds","url":"classes/bridgeoptions.html#inboundpermitteds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BridgeOptions"},{"id":26,"kind":1024,"name":"outboundPermitteds","url":"classes/bridgeoptions.html#outboundpermitteds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BridgeOptions"},{"id":27,"kind":128,"name":"PermittedOptions","url":"classes/permittedoptions.html","classes":"tsd-kind-class"},{"id":28,"kind":1024,"name":"address","url":"classes/permittedoptions.html#address","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PermittedOptions"},{"id":29,"kind":1024,"name":"addressRegex","url":"classes/permittedoptions.html#addressregex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PermittedOptions"},{"id":30,"kind":1024,"name":"match","url":"classes/permittedoptions.html#match","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PermittedOptions"},{"id":31,"kind":1024,"name":"requiredAuthority","url":"classes/permittedoptions.html#requiredauthority","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PermittedOptions"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"BridgeEventType","url":"enums/bridgeeventtype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"SOCKET_CREATED","url":"enums/bridgeeventtype.html#socket_created","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":2,"kind":16,"name":"SOCKET_CLOSED","url":"enums/bridgeeventtype.html#socket_closed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":3,"kind":16,"name":"SOCKET_IDLE","url":"enums/bridgeeventtype.html#socket_idle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":4,"kind":16,"name":"SOCKET_PING","url":"enums/bridgeeventtype.html#socket_ping","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":5,"kind":16,"name":"SEND","url":"enums/bridgeeventtype.html#send","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":6,"kind":16,"name":"PUBLISH","url":"enums/bridgeeventtype.html#publish","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":7,"kind":16,"name":"RECEIVE","url":"enums/bridgeeventtype.html#receive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":8,"kind":16,"name":"REGISTER","url":"enums/bridgeeventtype.html#register","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":9,"kind":16,"name":"UNREGISTER","url":"enums/bridgeeventtype.html#unregister","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"BridgeEventType"},{"id":10,"kind":128,"name":"BaseBridgeEvent","url":"classes/basebridgeevent.html","classes":"tsd-kind-class"},{"id":11,"kind":2048,"name":"setHandler","url":"classes/basebridgeevent.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":12,"kind":2048,"name":"complete","url":"classes/basebridgeevent.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":13,"kind":2048,"name":"tryComplete","url":"classes/basebridgeevent.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":14,"kind":2048,"name":"result","url":"classes/basebridgeevent.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":15,"kind":2048,"name":"compose","url":"classes/basebridgeevent.html#compose","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"BaseBridgeEvent"},{"id":16,"kind":2048,"name":"map","url":"classes/basebridgeevent.html#map","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"BaseBridgeEvent"},{"id":17,"kind":2048,"name":"completer","url":"classes/basebridgeevent.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":18,"kind":2048,"name":"recover","url":"classes/basebridgeevent.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":19,"kind":2048,"name":"otherwise","url":"classes/basebridgeevent.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":20,"kind":2048,"name":"otherwiseEmpty","url":"classes/basebridgeevent.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":21,"kind":2048,"name":"type","url":"classes/basebridgeevent.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":22,"kind":2048,"name":"getRawMessage","url":"classes/basebridgeevent.html#getrawmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":23,"kind":2048,"name":"setRawMessage","url":"classes/basebridgeevent.html#setrawmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BaseBridgeEvent"},{"id":24,"kind":128,"name":"BridgeOptions","url":"classes/bridgeoptions.html","classes":"tsd-kind-class"},{"id":25,"kind":512,"name":"constructor","url":"classes/bridgeoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"BridgeOptions"},{"id":26,"kind":2048,"name":"getInboundPermitteds","url":"classes/bridgeoptions.html#getinboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":27,"kind":2048,"name":"setInboundPermitteds","url":"classes/bridgeoptions.html#setinboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":28,"kind":2048,"name":"addInboundPermitted","url":"classes/bridgeoptions.html#addinboundpermitted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":29,"kind":2048,"name":"getOutboundPermitteds","url":"classes/bridgeoptions.html#getoutboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":30,"kind":2048,"name":"setOutboundPermitteds","url":"classes/bridgeoptions.html#setoutboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":31,"kind":2048,"name":"addOutboundPermitted","url":"classes/bridgeoptions.html#addoutboundpermitted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":32,"kind":128,"name":"PermittedOptions","url":"classes/permittedoptions.html","classes":"tsd-kind-class"},{"id":33,"kind":512,"name":"constructor","url":"classes/permittedoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PermittedOptions"},{"id":34,"kind":2048,"name":"getAddress","url":"classes/permittedoptions.html#getaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":35,"kind":2048,"name":"setAddress","url":"classes/permittedoptions.html#setaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":36,"kind":2048,"name":"getAddressRegex","url":"classes/permittedoptions.html#getaddressregex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":37,"kind":2048,"name":"setAddressRegex","url":"classes/permittedoptions.html#setaddressregex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":38,"kind":2048,"name":"getMatch","url":"classes/permittedoptions.html#getmatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":39,"kind":2048,"name":"setMatch","url":"classes/permittedoptions.html#setmatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":40,"kind":2048,"name":"getRequiredAuthority","url":"classes/permittedoptions.html#getrequiredauthority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"},{"id":41,"kind":2048,"name":"setRequiredAuthority","url":"classes/permittedoptions.html#setrequiredauthority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PermittedOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/bridge-common/classes/basebridgeevent.html b/docs/@vertx/bridge-common/classes/basebridgeevent.html index 9bfd7d05b..feaa034cf 100644 --- a/docs/@vertx/bridge-common/classes/basebridgeevent.html +++ b/docs/@vertx/bridge-common/classes/basebridgeevent.html @@ -68,7 +68,12 @@

    Class BaseBridgeEvent

    Hierarchy

    • - BaseBridgeEvent + any +
        +
      • + BaseBridgeEvent +
        • +
    @@ -81,9 +86,9 @@

    Methods

    • complete
    • completer
      • -
    • compose
      • +
    • compose
    • getRawMessage
      • -
    • map
      • +
    • map
    • otherwise
    • otherwiseEmpty
    • recover
      • @@ -109,7 +114,7 @@

      complete

    • Parameters

      @@ -132,24 +137,27 @@

      completer

    • Returns function

        • -
        • (result: AsyncResult): void
          • +
        • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>

        • Parameters

          • -
            result: AsyncResult
            +
            res: AsyncResult<boolean>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<boolean>> +

        • @@ -157,20 +165,26 @@

        Returns void

    -
    +

    compose

    -
      -
    • compose(handler: function, next: Future): Future
      • -
    • compose(mapper: function): Future
      • +
        +
      • compose<U>(handler: function, next: Future<U>): Future<U>
        • +
      • compose<U>(mapper: function): Future<U>
      • +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • @@ -178,34 +192,43 @@
          handler: function
            • -
            • (result: boolean): void
              • +
            • (res: boolean): void | Handler<boolean>

            • Parameters

              • -
                result: boolean
                +
                res: boolean
              -

              Returns void

              +

              Returns void + | + Handler<boolean> +

        • -
          next: Future
          +
          next: Future<U>
        -

        Returns Future

        +

        Returns Future<U>

      • +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • @@ -213,24 +236,24 @@
          mapper: function
            • -
            • (t: boolean): Future
              • +
            • (arg: boolean): Future<U>

            • Parameters

              • -
                t: boolean
                +
                arg: boolean
              -

              Returns Future

              +

              Returns Future<U>

        -

        Returns Future

        +

        Returns Future<U>

    @@ -244,34 +267,45 @@

    getRawMessage

  • -

    Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is +

    Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved. If the returned message is modified, {@link #setRawMessage} should be called with the new message.

    Returns object

    the raw JSON message for the event

    +
      +
    • +
      [key: string]: any
      +
      • +
    • -
    +

    map

    -
      -
    • map(mapper: function): Future
      • +
        +
      • map<U>(mapper: function): Future<U>
      • +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • @@ -279,24 +313,24 @@
          mapper: function
            • -
            • (t: boolean): any
              • +
            • (arg: boolean): U

            • Parameters

              • -
                t: boolean
                +
                arg: boolean
              -

              Returns any

              +

              Returns U

        -

        Returns Future

        +

        Returns Future<U>

    @@ -304,14 +338,14 @@

    Returns Future

    otherwise

      -
    • otherwise(mapper: function): Future
      • -
    • otherwise(value: boolean): Future
      • +
    • otherwise(mapper: function): Future<boolean>
      • +
    • otherwise(value: boolean): Future<boolean>

    • Parameters

      @@ -321,14 +355,14 @@
      mapper: function
        • -
        • (t: Error): boolean
          • +
        • (arg: Error): boolean

        • Parameters

          • -
            t: Error
            +
            arg: Error

          Returns boolean

          @@ -338,12 +372,12 @@

          Returns boolean

        -

        Returns Future

        +

        Returns Future<boolean>

      • Parameters

        @@ -352,7 +386,7 @@

        Parameters

        value: boolean
      -

      Returns Future

      +

      Returns Future<boolean>

    @@ -360,16 +394,16 @@

    Returns Future

    otherwiseEmpty

      -
    • otherwiseEmpty(): Future
      • +
    • otherwiseEmpty(): Future<boolean>
    • -

      Returns Future

      +

      Returns Future<boolean>

    @@ -377,13 +411,13 @@

    Returns Future

    recover

      -
    • recover(mapper: function): Future
      • +
    • recover(mapper: function): Future<boolean>

    • Parameters

      @@ -393,24 +427,24 @@
      mapper: function
        • -
        • (t: Error): Future
          • +
        • (arg: Error): Future<boolean>

        • Parameters

          • -
            t: Error
            +
            arg: Error
          -

          Returns Future

          +

          Returns Future<boolean>

    -

    Returns Future

    +

    Returns Future<boolean>

    @@ -424,7 +458,7 @@

    result

  • Returns boolean

    @@ -435,13 +469,13 @@

    Returns boolean

    setHandler

      -
    • setHandler(arg0: function): Future
      • +
    • setHandler(arg0: function): Future<boolean>

    • Parameters

      @@ -451,24 +485,27 @@
      arg0: function
        • -
        • (result: AsyncResult<boolean>): void
          • +
        • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>

        • Parameters

          • -
            result: AsyncResult<boolean>
            +
            res: AsyncResult<boolean>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<boolean>> +

    -

    Returns Future

    +

    Returns Future<boolean>

    • @@ -482,12 +519,12 @@

    setRawMessage

  • -

    Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is +

    Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved.

    @@ -498,6 +535,11 @@
    message: object

    the raw message

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns BaseBridgeEvent

    @@ -515,7 +557,7 @@

    tryComplete

  • Parameters

    @@ -538,7 +580,7 @@

    type

  • @@ -574,13 +616,13 @@

    Returns completer

    • -
  • +
  • compose
  • getRawMessage
    • -
  • +
  • map
  • diff --git a/docs/@vertx/bridge-common/classes/bridgeoptions.html b/docs/@vertx/bridge-common/classes/bridgeoptions.html index 0c97bd9c1..4dbdaefa4 100644 --- a/docs/@vertx/bridge-common/classes/bridgeoptions.html +++ b/docs/@vertx/bridge-common/classes/bridgeoptions.html @@ -77,64 +77,223 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    - -

    inboundPermitteds

    -
    inboundPermitteds: PermittedOptions
    - -
    -
    -

    Sets the list of inbound permitted options.

    -
    -
    -
    param
    -

    the list to use, must not be {@link null}. This method use the direct list reference - (and doesn't create a copy).

    -
    -
    returns
    -

    the current BridgeOptions.

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    outboundPermitteds

    -
    outboundPermitteds: PermittedOptions
    - -
    -
    -

    Sets the list of outbound permitted options.

    -
    -
    -
    param
    -

    the list to use, must not be {@link null}. This method use the direct list reference - (and doesn't create a copy).

    -
    -
    returns
    -

    the current BridgeOptions.

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addInboundPermitted

    + +
      +
    • + +
      +
      +

      Sets the list of inbound permitted options.

      +
      +
      +

      Parameters

      + +

      Returns BridgeOptions

      +

      the current BridgeOptions.

      +
      • +
    +
    +
    + +

    addOutboundPermitted

    + +
      +
    • + +
      +
      +

      Sets the list of outbound permitted options.

      +
      +
      +

      Parameters

      + +

      Returns BridgeOptions

      +

      the current BridgeOptions.

      +
      • +
    +
    +
    + +

    getInboundPermitteds

    + +
      +
    • + +
      +
      +

      Sets the list of inbound permitted options.

      +
      +
      +

      Returns PermittedOptions

      +

      the current BridgeOptions.

      +
      • +
    +
    +
    + +

    getOutboundPermitteds

    + +
      +
    • + +
      +
      +

      Sets the list of outbound permitted options.

      +
      +
      +

      Returns PermittedOptions

      +

      the current BridgeOptions.

      +
      • +
    +
    +
    + +

    setInboundPermitteds

    + +
      +
    • + +
      +
      +

      Sets the list of inbound permitted options.

      +
      +
      +

      Parameters

      + +

      Returns BridgeOptions

      +

      the current BridgeOptions.

      +
      • +
    +
    +
    + +

    setOutboundPermitteds

    + +
      +
    • + +
      +
      +

      Sets the list of outbound permitted options.

      +
      +
      +

      Parameters

      + +

      Returns BridgeOptions

      +

      the current BridgeOptions.

      +
      • +
    @@ -159,11 +318,26 @@

    outboundPermitteds

  • BridgeOptions
    • diff --git a/docs/@vertx/bridge-common/classes/permittedoptions.html b/docs/@vertx/bridge-common/classes/permittedoptions.html index 81d53689b..8058f34e9 100644 --- a/docs/@vertx/bridge-common/classes/permittedoptions.html +++ b/docs/@vertx/bridge-common/classes/permittedoptions.html @@ -77,114 +77,301 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    address

    -
    address: string
    - -
    -
    -

    The exact address the message is being sent to. If you want to allow messages based on - an exact address you use this field.

    -
    -
    -
    param
    -

    the address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    addressRegex

    -
    addressRegex: string
    - -
    -
    -

    A regular expression that will be matched against the address. If you want to allow messages - based on a regular expression you use this field. If the {@link #setAddress} value is specified - this will be ignored.

    -
    -
    -
    param
    -

    the address regex

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAddress

    +
      +
    • getAddress(): string
      • +
    +
      +
    • + +
      +
      +

      The exact address the message is being sent to. If you want to allow messages based on + an exact address you use this field.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    match

    -
    match: object
    - -
    -
    -

    This allows you to allow messages based on their structure. Any fields in the match must exist in the - message with the same values for them to be allowed. This currently only works with JSON messages.

    -
    -
    -
    param
    -

    the match json object

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getAddressRegex

    +
      +
    • getAddressRegex(): string
      • +
    +
      +
    • + +
      +
      +

      A regular expression that will be matched against the address. If you want to allow messages + based on a regular expression you use this field. If the {@link #setAddress} value is specified + this will be ignored.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    requiredAuthority

    -
    requiredAuthority: string
    - -
    -
    -

    Declare a specific authority that user must have in order to allow messages

    -
    -
    -
    param
    -

    the authority

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMatch

    +
      +
    • getMatch(): object
      • +
    +
      +
    • + +
      +
      +

      This allows you to allow messages based on their structure. Any fields in the match must exist in the + message with the same values for them to be allowed. This currently only works with JSON messages.

      +
      +
      +

      Returns object

      +

      a reference to this, so the API can be used fluently

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    getRequiredAuthority

    +
      +
    • getRequiredAuthority(): string
      • +
    +
      +
    • + +
      +
      +

      Declare a specific authority that user must have in order to allow messages

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAddress

    + +
      +
    • + +
      +
      +

      The exact address the message is being sent to. If you want to allow messages based on + an exact address you use this field.

      +
      +
      +

      Parameters

      +
        +
      • +
        address: string
        +
        +

        the address

        +
        +
        • +
      +

      Returns PermittedOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAddressRegex

    + +
      +
    • + +
      +
      +

      A regular expression that will be matched against the address. If you want to allow messages + based on a regular expression you use this field. If the {@link #setAddress} value is specified + this will be ignored.

      +
      +
      +

      Parameters

      +
        +
      • +
        addressRegex: string
        +
        +

        the address regex

        +
        +
        • +
      +

      Returns PermittedOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMatch

    + +
      +
    • + +
      +
      +

      This allows you to allow messages based on their structure. Any fields in the match must exist in the + message with the same values for them to be allowed. This currently only works with JSON messages.

      +
      +
      +

      Parameters

      +
        +
      • +
        match: object
        +
        +

        the match json object

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns PermittedOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRequiredAuthority

    + +
      +
    • + +
      +
      +

      Declare a specific authority that user must have in order to allow messages

      +
      +
      +

      Parameters

      +
        +
      • +
        requiredAuthority: string
        +
        +

        the authority

        +
        +
        • +
      +

      Returns PermittedOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -212,17 +399,32 @@

    requiredAuthority

  • PermittedOptions
    • diff --git a/docs/@vertx/bridge-common/enums/bridgeeventtype.html b/docs/@vertx/bridge-common/enums/bridgeeventtype.html index be31dbaf1..37af5eb2d 100644 --- a/docs/@vertx/bridge-common/enums/bridgeeventtype.html +++ b/docs/@vertx/bridge-common/enums/bridgeeventtype.html @@ -93,7 +93,7 @@

    PUBLISH

    PUBLISH:
    @@ -103,7 +103,7 @@

    RECEIVE

    RECEIVE:
    @@ -113,7 +113,7 @@

    REGISTER

    REGISTER:
    @@ -123,7 +123,7 @@

    SEND

    SEND:
    @@ -133,7 +133,7 @@

    SOCKET_CLOSED

    SOCKET_CLOSED:
    @@ -143,7 +143,7 @@

    SOCKET_CREATED

    SOCKET_CREATED:
    @@ -153,7 +153,7 @@

    SOCKET_IDLE

    SOCKET_IDLE:
    @@ -163,7 +163,7 @@

    SOCKET_PING

    SOCKET_PING:
    @@ -173,7 +173,7 @@

    UNREGISTER

    UNREGISTER:
    diff --git a/docs/@vertx/camel-bridge/assets/js/search.js b/docs/@vertx/camel-bridge/assets/js/search.js deleted file mode 100644 index 4826f7d1b..000000000 --- a/docs/@vertx/camel-bridge/assets/js/search.js +++ /dev/null @@ -1,3 +0,0 @@ -var typedoc = typedoc || {}; - typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{},"rows":[]}; \ No newline at end of file diff --git a/docs/@vertx/camel-bridge/assets/css/main.css b/docs/@vertx/cassandra-client/assets/css/main.css similarity index 100% rename from docs/@vertx/camel-bridge/assets/css/main.css rename to docs/@vertx/cassandra-client/assets/css/main.css diff --git a/docs/@vertx/camel-bridge/assets/css/main.css.map b/docs/@vertx/cassandra-client/assets/css/main.css.map similarity index 100% rename from docs/@vertx/camel-bridge/assets/css/main.css.map rename to docs/@vertx/cassandra-client/assets/css/main.css.map diff --git a/docs/@vertx/camel-bridge/assets/images/icons.png b/docs/@vertx/cassandra-client/assets/images/icons.png similarity index 100% rename from docs/@vertx/camel-bridge/assets/images/icons.png rename to docs/@vertx/cassandra-client/assets/images/icons.png diff --git a/docs/@vertx/camel-bridge/assets/images/icons@2x.png b/docs/@vertx/cassandra-client/assets/images/icons@2x.png similarity index 100% rename from docs/@vertx/camel-bridge/assets/images/icons@2x.png rename to docs/@vertx/cassandra-client/assets/images/icons@2x.png diff --git a/docs/@vertx/camel-bridge/assets/images/widgets.png b/docs/@vertx/cassandra-client/assets/images/widgets.png similarity index 100% rename from docs/@vertx/camel-bridge/assets/images/widgets.png rename to docs/@vertx/cassandra-client/assets/images/widgets.png diff --git a/docs/@vertx/camel-bridge/assets/images/widgets@2x.png b/docs/@vertx/cassandra-client/assets/images/widgets@2x.png similarity index 100% rename from docs/@vertx/camel-bridge/assets/images/widgets@2x.png rename to docs/@vertx/cassandra-client/assets/images/widgets@2x.png diff --git a/docs/@vertx/camel-bridge/assets/js/main.js b/docs/@vertx/cassandra-client/assets/js/main.js similarity index 100% rename from docs/@vertx/camel-bridge/assets/js/main.js rename to docs/@vertx/cassandra-client/assets/js/main.js diff --git a/docs/@vertx/cassandra-client/assets/js/search.js b/docs/@vertx/cassandra-client/assets/js/search.js new file mode 100644 index 000000000..44cae222c --- /dev/null +++ b/docs/@vertx/cassandra-client/assets/js/search.js @@ -0,0 +1,3 @@ +var typedoc = typedoc || {}; + typedoc.search = typedoc.search || {}; + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"CassandraClientOptions","url":"classes/cassandraclientoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/cassandraclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CassandraClientOptions"},{"id":2,"kind":2048,"name":"getContactPoints","url":"classes/cassandraclientoptions.html#getcontactpoints","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClientOptions"},{"id":3,"kind":2048,"name":"setContactPoints","url":"classes/cassandraclientoptions.html#setcontactpoints","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClientOptions"},{"id":4,"kind":2048,"name":"addContactPoint","url":"classes/cassandraclientoptions.html#addcontactpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClientOptions"},{"id":5,"kind":2048,"name":"port","url":"classes/cassandraclientoptions.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClientOptions"},{"id":6,"kind":2048,"name":"setPort","url":"classes/cassandraclientoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClientOptions"},{"id":7,"kind":128,"name":"CassandraClient","url":"classes/cassandraclient.html","classes":"tsd-kind-class"},{"id":8,"kind":2048,"name":"createNonShared","url":"classes/cassandraclient.html#createnonshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CassandraClient"},{"id":9,"kind":2048,"name":"createShared","url":"classes/cassandraclient.html#createshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CassandraClient"},{"id":10,"kind":2048,"name":"connect","url":"classes/cassandraclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClient"},{"id":11,"kind":2048,"name":"isConnected","url":"classes/cassandraclient.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClient"},{"id":12,"kind":2048,"name":"execute","url":"classes/cassandraclient.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClient"},{"id":13,"kind":2048,"name":"queryStream","url":"classes/cassandraclient.html#querystream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClient"},{"id":14,"kind":2048,"name":"disconnect","url":"classes/cassandraclient.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraClient"},{"id":15,"kind":128,"name":"CassandraRowStream","url":"classes/cassandrarowstream.html","classes":"tsd-kind-class"},{"id":16,"kind":2048,"name":"exceptionHandler","url":"classes/cassandrarowstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraRowStream"},{"id":17,"kind":2048,"name":"pause","url":"classes/cassandrarowstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraRowStream"},{"id":18,"kind":2048,"name":"resume","url":"classes/cassandrarowstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraRowStream"},{"id":19,"kind":2048,"name":"endHandler","url":"classes/cassandrarowstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraRowStream"},{"id":20,"kind":2048,"name":"fetch","url":"classes/cassandrarowstream.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CassandraRowStream"},{"id":21,"kind":128,"name":"ResultSet","url":"classes/resultset.html","classes":"tsd-kind-class"},{"id":22,"kind":2048,"name":"isExhausted","url":"classes/resultset.html#isexhausted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":23,"kind":2048,"name":"isFullyFetched","url":"classes/resultset.html#isfullyfetched","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":24,"kind":2048,"name":"getAvailableWithoutFetching","url":"classes/resultset.html#getavailablewithoutfetching","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":25,"kind":2048,"name":"fetchMoreResults","url":"classes/resultset.html#fetchmoreresults","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":26,"kind":2048,"name":"wasApplied","url":"classes/resultset.html#wasapplied","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"}]}; \ No newline at end of file diff --git a/docs/@vertx/cassandra-client/classes/cassandraclient.html b/docs/@vertx/cassandra-client/classes/cassandraclient.html new file mode 100644 index 000000000..3a6dc5ebc --- /dev/null +++ b/docs/@vertx/cassandra-client/classes/cassandraclient.html @@ -0,0 +1,718 @@ + + + + + + CassandraClient | @vertx/cassandra-client + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class CassandraClient

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + CassandraClient +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    connect

    + +
      +
    • + +
      +
      +

      Connect to a Cassandra service.

      +
      +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    • + +
      +
      +

      Connect to a Cassandra service.

      +
      +
      +

      Parameters

      +
        +
      • +
        connectHandler: function
        +
        +

        handler called when asynchronous connect call ends

        +
        +
          +
        • +
            +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: AsyncResult<void>
              +
              • +
            +

            Returns void + | + Handler<AsyncResult<void>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    • + +
      +
      +

      Connect to a Cassandra service.

      +
      +
      +

      Parameters

      +
        +
      • +
        keyspace: string
        +
        +

        The name of the keyspace to use for the created connection.

        +
        +
        • +
      • +
        connectHandler: function
        +
        +

        handler called when asynchronous connect call ends

        +
        +
          +
        • +
            +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: AsyncResult<void>
              +
              • +
            +

            Returns void + | + Handler<AsyncResult<void>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    +
    +
    + +

    disconnect

    + +
      +
    • + +
      +
      +

      Disconnects from the Cassandra service.

      +
      +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    • + +
      +
      +

      Disconnects from the Cassandra service.

      +
      +
      +

      Parameters

      +
        +
      • +
        disconnectHandler: function
        +
        +

        handler called when asynchronous disconnect call ends

        +
        +
          +
        • +
            +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: AsyncResult<void>
              +
              • +
            +

            Returns void + | + Handler<AsyncResult<void>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    +
    +
    + +

    execute

    + +
      +
    • + +
      +
      +

      Execute the query and provide a handler for consuming results.

      +
      +
      +

      Parameters

      +
        +
      • +
        query: string
        +
        +

        the query to execute

        +
        +
        • +
      • +
        resultHandler: function
        +
        +

        handler called when result of execution is present, but can be not fully fetched

        +
        +
          +
        • + +
            +
          • +

            Parameters

            + +

            Returns void + | + Handler<AsyncResult<ResultSet>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    +
    +
    + +

    isConnected

    +
      +
    • isConnected(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      whether this Cassandra client instance connected.

      +
      • +
    +
    +
    + +

    queryStream

    +
      +
    • queryStream(sql: string, rowStreamHandler: function): CassandraClient
      • +
    +
      +
    • + +
      +
      +

      Executes the given SQL SELECT statement which returns the results of the query as a read stream.

      +
      +
      +

      Parameters

      +
        +
      • +
        sql: string
        +
        +

        the SQL to execute. For example SELECT * FROM table ....

        +
        +
        • +
      • +
        rowStreamHandler: function
        +
        +

        the handler which is called once the operation completes. It will return an instance of CassandraRowStream.

        +
        + +
        • +
      +

      Returns CassandraClient

      +

      current Cassandra client instance

      +
      • +
    +
    +
    + +

    Static createNonShared

    + +
      +
    • + +
      +
      +

      Like {@link CassandraClient#createNonShared(Vertx, CassandraClientOptions)} but with default client options.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        • +
      +

      Returns CassandraClient

      +
      • +
    • + +
      +
      +

      Create a Cassandra client which maintains its own data source. +

      + It is not recommended to create several non shared clients in an application. + Your application should either use only single non shared client, or use shared client. + This is because CassandraClient backed by {@link com.datastax.driver.core.Session}. + And Datastax does not recommended to have several {@link com.datastax.driver.core.Session} + instances. Better to have only one, and share it.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        +

        the Vert.x instance

        +
        +
        • +
      • +
        cassandraClientOptions: CassandraClientOptions
        +
        +

        the options

        +
        +
        • +
      +

      Returns CassandraClient

      +

      the client

      +
      • +
    +
    +
    + +

    Static createShared

    + +
      +
    • + +
      +
      +

      Like {@link CassandraClient#createShared(Vertx, String, CassandraClientOptions)}, but with default client options and datasource.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        • +
      +

      Returns CassandraClient

      +
      • +
    • + +
      +
      +

      Like {@link CassandraClient#createShared(Vertx, String, CassandraClientOptions)}, but with default client options.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        • +
      • +
        datasourceName: string
        +
        • +
      +

      Returns CassandraClient

      +
      • +
    • + +
      +
      +

      Like {@link CassandraClient#createShared(Vertx, String, CassandraClientOptions)}, but with datasource name.

      +
      +
      +

      Parameters

      + +

      Returns CassandraClient

      +
      • +
    • + +
      +
      +

      Create a Cassandra client which shares its data source with any other Cassandra clients created with the same + data source name.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertx: Vertx
        +
        +

        the Vert.x instance

        +
        +
        • +
      • +
        datasourceName: string
        +
        +

        the data source name

        +
        +
        • +
      • +
        cassandraClientOptions: CassandraClientOptions
        +
        +

        the options

        +
        +
        • +
      +

      Returns CassandraClient

      +

      the client

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/cassandra-client/classes/cassandraclientoptions.html b/docs/@vertx/cassandra-client/classes/cassandraclientoptions.html new file mode 100644 index 000000000..df9a651b9 --- /dev/null +++ b/docs/@vertx/cassandra-client/classes/cassandraclientoptions.html @@ -0,0 +1,396 @@ + + + + + + CassandraClientOptions | @vertx/cassandra-client + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class CassandraClientOptions

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + CassandraClientOptions +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    addContactPoint

    + +
      +
    • + +
      +
      +

      Set a list of hosts, where some of cluster nodes is located.

      +
      +
      +

      Parameters

      +
        +
      • +
        contactPoints: string
        +
        +

        the list of hosts

        +
        +
        • +
      +

      Returns CassandraClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getContactPoints

    +
      +
    • getContactPoints(): string
      • +
    +
      +
    • + +
      +
      +

      Set a list of hosts, where some of cluster nodes is located.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    port

    +
      +
    • port(): number
      • +
    +
      +
    • + +
      +
      +

      Set which port should be used for all the hosts to connect to a cassandra service.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setContactPoints

    + +
      +
    • + +
      +
      +

      Set a list of hosts, where some of cluster nodes is located.

      +
      +
      +

      Parameters

      +
        +
      • +
        contactPoints: string
        +
        +

        the list of hosts

        +
        +
        • +
      +

      Returns CassandraClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set which port should be used for all the hosts to connect to a cassandra service.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns CassandraClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/cassandra-client/classes/cassandrarowstream.html b/docs/@vertx/cassandra-client/classes/cassandrarowstream.html new file mode 100644 index 000000000..30612ec10 --- /dev/null +++ b/docs/@vertx/cassandra-client/classes/cassandrarowstream.html @@ -0,0 +1,369 @@ + + + + + + CassandraRowStream | @vertx/cassandra-client + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class CassandraRowStream

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + CassandraRowStream +
      • +
    +
    +
    +

    Implements

    +
      +
    • any
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    endHandler

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        handler: function
        +
          +
        • +
            +
          • (res: void): void | Handler<void> | null | undefined
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: void
              +
              • +
            +

            Returns void + | + Handler<void> + | + null + | + undefined +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns CassandraRowStream

      +
      • +
    +
    +
    + +

    exceptionHandler

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        handler: function
        +
          +
        • +
            +
          • (res: Error): void | Handler<Error> | null | undefined
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: Error
              +
              • +
            +

            Returns void + | + Handler<Error> + | + null + | + undefined +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns CassandraRowStream

      +
      • +
    +
    +
    + +

    fetch

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        l: number
        +
        • +
      +

      Returns CassandraRowStream

      +
      • +
    +
    +
    + +

    pause

    + + +
    +
    + +

    resume

    + + +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/cassandra-client/classes/resultset.html b/docs/@vertx/cassandra-client/classes/resultset.html new file mode 100644 index 000000000..230baabd5 --- /dev/null +++ b/docs/@vertx/cassandra-client/classes/resultset.html @@ -0,0 +1,360 @@ + + + + + + ResultSet | @vertx/cassandra-client + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class ResultSet

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + ResultSet +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    fetchMoreResults

    +
      +
    • fetchMoreResults(handler: function): ResultSet
      • +
    +
      +
    • + +
      +
      +
      see
      +

      com.datastax.driver.core.ResultSet#fetchMoreResults()

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        handler: function
        +
        +

        handler called when result is fetched

        +
        +
          +
        • +
            +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: AsyncResult<void>
              +
              • +
            +

            Returns void + | + Handler<AsyncResult<void>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns ResultSet

      +
      • +
    +
    +
    + +

    getAvailableWithoutFetching

    +
      +
    • getAvailableWithoutFetching(): number
      • +
    +
      +
    • + +
      +
      +
      see
      +

      com.datastax.driver.core.ResultSet#getAvailableWithoutFetching()

      +
      +
      +
      +

      Returns number

      +
      • +
    +
    +
    + +

    isExhausted

    +
      +
    • isExhausted(): boolean
      • +
    +
      +
    • + +
      +
      +
      see
      +

      com.datastax.driver.core.ResultSet#isExhausted()

      +
      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isFullyFetched

    +
      +
    • isFullyFetched(): boolean
      • +
    +
      +
    • + +
      +
      +
      see
      +

      com.datastax.driver.core.ResultSet#isFullyFetched()

      +
      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    wasApplied

    +
      +
    • wasApplied(): boolean
      • +
    +
      +
    • + +
      +
      +
      see
      +

      com.datastax.driver.core.ResultSet#wasApplied

      +
      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/hawkular-metrics/globals.html b/docs/@vertx/cassandra-client/globals.html similarity index 86% rename from docs/@vertx/hawkular-metrics/globals.html rename to docs/@vertx/cassandra-client/globals.html index 5b77d36e1..bd560a4e3 100644 --- a/docs/@vertx/hawkular-metrics/globals.html +++ b/docs/@vertx/cassandra-client/globals.html @@ -3,7 +3,7 @@ - @vertx/hawkular-metrics + @vertx/cassandra-client @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/hawkular-metrics + @vertx/cassandra-client
    @@ -54,7 +54,7 @@ Globals -

    @vertx/hawkular-metrics

    +

    @vertx/cassandra-client

    @@ -65,18 +65,13 @@

    @vertx/hawkular-metrics

    Index

    -
    -

    Enumerations

    - -

    Classes

    @@ -93,17 +88,17 @@

    Classes

    diff --git a/docs/@vertx/hawkular-metrics/index.html b/docs/@vertx/cassandra-client/index.html similarity index 88% rename from docs/@vertx/hawkular-metrics/index.html rename to docs/@vertx/cassandra-client/index.html index 9b9e52927..219e40693 100644 --- a/docs/@vertx/hawkular-metrics/index.html +++ b/docs/@vertx/cassandra-client/index.html @@ -3,7 +3,7 @@ - @vertx/hawkular-metrics + @vertx/cassandra-client @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/hawkular-metrics + @vertx/cassandra-client
    @@ -54,7 +54,7 @@ Globals -

    @vertx/hawkular-metrics

    +

    @vertx/cassandra-client

    @@ -62,22 +62,22 @@

    @vertx/hawkular-metrics

    -

    npm (scoped) - npm

    +

    npm (scoped) + npm

    Generated JavaScript bindings for Eclipse Vert.x.

    Documentation

    Usage

    Import the required API/Enum/DataObject and profit!

    // Base API
-const Api = require('@vertx/hawkular');
+const Api = require('@vertx/cassandra');
 // Base ENUMs
-const Enums = require('@vertx/hawkular/enums');
+const Enums = require('@vertx/cassandra/enums');
 // DataObject's
-const Options = require('@vertx/hawkular/options');
+const Options = require('@vertx/cassandra/options');
 
 // refer to the API docs for specific help...
 
@@ -107,17 +107,17 @@ 
 			
 			
diff --git a/docs/@vertx/circuit-breaker/assets/js/search.js b/docs/@vertx/circuit-breaker/assets/js/search.js
index a01fcaecd..8060eb4ec 100644
--- a/docs/@vertx/circuit-breaker/assets/js/search.js
+++ b/docs/@vertx/circuit-breaker/assets/js/search.js
@@ -1,3 +1,3 @@
 var typedoc = typedoc || {};
             typedoc.search = typedoc.search || {};
-            typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"CircuitBreakerOptions","url":"classes/circuitbreakeroptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"fallbackOnFailure","url":"classes/circuitbreakeroptions.html#fallbackonfailure","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":2,"kind":1024,"name":"maxFailures","url":"classes/circuitbreakeroptions.html#maxfailures","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":3,"kind":1024,"name":"maxRetries","url":"classes/circuitbreakeroptions.html#maxretries","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":4,"kind":1024,"name":"metricsRollingBuckets","url":"classes/circuitbreakeroptions.html#metricsrollingbuckets","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":5,"kind":1024,"name":"metricsRollingWindow","url":"classes/circuitbreakeroptions.html#metricsrollingwindow","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":6,"kind":1024,"name":"notificationAddress","url":"classes/circuitbreakeroptions.html#notificationaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":7,"kind":1024,"name":"notificationPeriod","url":"classes/circuitbreakeroptions.html#notificationperiod","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":8,"kind":1024,"name":"resetTimeout","url":"classes/circuitbreakeroptions.html#resettimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":9,"kind":1024,"name":"timeout","url":"classes/circuitbreakeroptions.html#timeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":10,"kind":128,"name":"CircuitBreaker","url":"classes/circuitbreaker.html","classes":"tsd-kind-class"},{"id":11,"kind":2048,"name":"create","url":"classes/circuitbreaker.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CircuitBreaker"},{"id":12,"kind":2048,"name":"close","url":"classes/circuitbreaker.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":13,"kind":2048,"name":"openHandler","url":"classes/circuitbreaker.html#openhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":14,"kind":2048,"name":"halfOpenHandler","url":"classes/circuitbreaker.html#halfopenhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":15,"kind":2048,"name":"closeHandler","url":"classes/circuitbreaker.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":16,"kind":2048,"name":"executeWithFallback","url":"classes/circuitbreaker.html#executewithfallback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":17,"kind":2048,"name":"executeCommandWithFallback","url":"classes/circuitbreaker.html#executecommandwithfallback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":18,"kind":2048,"name":"execute","url":"classes/circuitbreaker.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":19,"kind":2048,"name":"executeCommand","url":"classes/circuitbreaker.html#executecommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":20,"kind":2048,"name":"executeAndReport","url":"classes/circuitbreaker.html#executeandreport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":21,"kind":2048,"name":"executeAndReportWithFallback","url":"classes/circuitbreaker.html#executeandreportwithfallback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":22,"kind":2048,"name":"fallback","url":"classes/circuitbreaker.html#fallback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":23,"kind":2048,"name":"reset","url":"classes/circuitbreaker.html#reset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":24,"kind":2048,"name":"open","url":"classes/circuitbreaker.html#open","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":25,"kind":2048,"name":"state","url":"classes/circuitbreaker.html#state","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":26,"kind":2048,"name":"failureCount","url":"classes/circuitbreaker.html#failurecount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":27,"kind":2048,"name":"name","url":"classes/circuitbreaker.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":28,"kind":128,"name":"HystrixMetricHandler","url":"classes/hystrixmetrichandler.html","classes":"tsd-kind-class"},{"id":29,"kind":2048,"name":"handle","url":"classes/hystrixmetrichandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HystrixMetricHandler"},{"id":30,"kind":2048,"name":"create","url":"classes/hystrixmetrichandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HystrixMetricHandler"}]};
\ No newline at end of file
+            typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"CircuitBreakerOptions","url":"classes/circuitbreakeroptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/circuitbreakeroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":2,"kind":2048,"name":"getFailuresRollingWindow","url":"classes/circuitbreakeroptions.html#getfailuresrollingwindow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":3,"kind":2048,"name":"setFailuresRollingWindow","url":"classes/circuitbreakeroptions.html#setfailuresrollingwindow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":4,"kind":2048,"name":"isFallbackOnFailure","url":"classes/circuitbreakeroptions.html#isfallbackonfailure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":5,"kind":2048,"name":"setFallbackOnFailure","url":"classes/circuitbreakeroptions.html#setfallbackonfailure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":6,"kind":2048,"name":"getMaxFailures","url":"classes/circuitbreakeroptions.html#getmaxfailures","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":7,"kind":2048,"name":"setMaxFailures","url":"classes/circuitbreakeroptions.html#setmaxfailures","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":8,"kind":2048,"name":"getMaxRetries","url":"classes/circuitbreakeroptions.html#getmaxretries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":9,"kind":2048,"name":"setMaxRetries","url":"classes/circuitbreakeroptions.html#setmaxretries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":10,"kind":2048,"name":"getMetricsRollingBuckets","url":"classes/circuitbreakeroptions.html#getmetricsrollingbuckets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":11,"kind":2048,"name":"setMetricsRollingBuckets","url":"classes/circuitbreakeroptions.html#setmetricsrollingbuckets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":12,"kind":2048,"name":"getMetricsRollingWindow","url":"classes/circuitbreakeroptions.html#getmetricsrollingwindow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":13,"kind":2048,"name":"setMetricsRollingWindow","url":"classes/circuitbreakeroptions.html#setmetricsrollingwindow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":14,"kind":2048,"name":"getNotificationAddress","url":"classes/circuitbreakeroptions.html#getnotificationaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":15,"kind":2048,"name":"setNotificationAddress","url":"classes/circuitbreakeroptions.html#setnotificationaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":16,"kind":2048,"name":"getNotificationPeriod","url":"classes/circuitbreakeroptions.html#getnotificationperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":17,"kind":2048,"name":"setNotificationPeriod","url":"classes/circuitbreakeroptions.html#setnotificationperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":18,"kind":2048,"name":"getResetTimeout","url":"classes/circuitbreakeroptions.html#getresettimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":19,"kind":2048,"name":"setResetTimeout","url":"classes/circuitbreakeroptions.html#setresettimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":20,"kind":2048,"name":"getTimeout","url":"classes/circuitbreakeroptions.html#gettimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":21,"kind":2048,"name":"setTimeout","url":"classes/circuitbreakeroptions.html#settimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreakerOptions"},{"id":22,"kind":128,"name":"CircuitBreaker","url":"classes/circuitbreaker.html","classes":"tsd-kind-class"},{"id":23,"kind":2048,"name":"create","url":"classes/circuitbreaker.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CircuitBreaker"},{"id":24,"kind":2048,"name":"close","url":"classes/circuitbreaker.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":25,"kind":2048,"name":"openHandler","url":"classes/circuitbreaker.html#openhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":26,"kind":2048,"name":"halfOpenHandler","url":"classes/circuitbreaker.html#halfopenhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":27,"kind":2048,"name":"closeHandler","url":"classes/circuitbreaker.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":28,"kind":2048,"name":"executeWithFallback","url":"classes/circuitbreaker.html#executewithfallback","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":29,"kind":2048,"name":"executeCommandWithFallback","url":"classes/circuitbreaker.html#executecommandwithfallback","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":30,"kind":2048,"name":"execute","url":"classes/circuitbreaker.html#execute","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":31,"kind":2048,"name":"executeCommand","url":"classes/circuitbreaker.html#executecommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":32,"kind":2048,"name":"executeAndReport","url":"classes/circuitbreaker.html#executeandreport","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":33,"kind":2048,"name":"executeAndReportWithFallback","url":"classes/circuitbreaker.html#executeandreportwithfallback","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":34,"kind":2048,"name":"fallback","url":"classes/circuitbreaker.html#fallback","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CircuitBreaker"},{"id":35,"kind":2048,"name":"reset","url":"classes/circuitbreaker.html#reset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":36,"kind":2048,"name":"open","url":"classes/circuitbreaker.html#open","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":37,"kind":2048,"name":"state","url":"classes/circuitbreaker.html#state","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":38,"kind":2048,"name":"failureCount","url":"classes/circuitbreaker.html#failurecount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":39,"kind":2048,"name":"name","url":"classes/circuitbreaker.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":40,"kind":2048,"name":"retryPolicy","url":"classes/circuitbreaker.html#retrypolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CircuitBreaker"},{"id":41,"kind":128,"name":"HystrixMetricHandler","url":"classes/hystrixmetrichandler.html","classes":"tsd-kind-class"},{"id":42,"kind":2048,"name":"handle","url":"classes/hystrixmetrichandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HystrixMetricHandler"},{"id":43,"kind":2048,"name":"create","url":"classes/hystrixmetrichandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HystrixMetricHandler"}]};
\ No newline at end of file
diff --git a/docs/@vertx/circuit-breaker/classes/circuitbreaker.html b/docs/@vertx/circuit-breaker/classes/circuitbreaker.html
index bc75385f3..799cd4a35 100644
--- a/docs/@vertx/circuit-breaker/classes/circuitbreaker.html
+++ b/docs/@vertx/circuit-breaker/classes/circuitbreaker.html
@@ -81,19 +81,20 @@ 
    Methods
    
 							
@@ -113,12 +114,12 @@ 
    close
    
 						
  • 
 							
 							
    
 								
    
-									
     Closes the circuit breaker. It stops sending events on its state on the event bus.
+									
    Closes the circuit breaker. It stops sending events on its state on the event bus.
 										This method is not related to the {@code close} state of the circuit breaker. To set the circuit breaker in the
 									{@code close} state, use {@link #reset()}.
    
 								
    
@@ -137,12 +138,12 @@ 
    closeHandler
    
 						
  • 
 							
 							
    
 								
    
-									
     Sets a {@link Handler} invoked when the circuit breaker state switches to close.
    
+									
    Sets a {@link Handler} invoked when the circuit breaker state switches to close.
    
 								
    
 							
    
 							
    Parameters
    
@@ -155,17 +156,20 @@ 
    handler: function
    
 									
      
 										
    • 
 											
        
-												
      • (result: void): void
        • 
+												
      • (res: void): void | Handler<void>
        • 
 											
      
 											
        
 												
      • 
 													
        Parameters
        
 													
          
 														
        • 
-															
          result: void
          
+															
          res: void
          
 														
          • 
 													
        
-													
        Returns void
        
+													
        Returns void
+														 | 
+														Handler<void>
+													
        
 												
        • 
 											
      
 										
      • 
@@ -177,24 +181,33 @@ 
      Returns 
+				
      
 					
 					
      execute
      
-					
        
-						
      • execute(command: function): Future
        • 
+					
          
+						
        • execute<T>(command: function): Future<T>
          • 
 					
        
 					
          
 						
        • 
 							
 							
          
 								
          
-									
           Same as {@link #executeWithFallback(Handler, Function)} but using the circuit breaker default fallback.
          
+									
          Same as {@link #executeWithFallback(Handler, Function)} but using the circuit breaker default fallback.
          
 								
          
 							
          
+							
          Type parameters
          
+							
            
+								
          • 
+									
            T
            
+									
            
+										
            the type of result
            
+									
            
+								
            • 
+							
          
 							
          Parameters
          
 							
            
 								
          • 
@@ -205,51 +218,63 @@ 
            command: function
            
 									
              
 										
            • 
 											
                
-												
              • (result: Future): void
                • 
+												
              • (res: Future<T>): void | Handler<Future<T>>
                • 
 											
              
 											
                
 												
              • 
 													
                Parameters
                
 													
                  
 														
                • 
-															
                  result: Future
                  
+															
                  res: Future<T>
                  
 														
                  • 
 													
                
-													
                Returns void
                
+													
                Returns void
+														 | 
+														Handler<Future<T>>
+													
                
 												
                • 
 											
              
 										
              • 
 									
            
 								
            • 
 							
          
-							
          Returns Future
          
+							
          Returns Future<T>
          
 							
          a future object completed when the operation or its fallback completes
          
 						
          • 
 					
        
 				
      
-				
      
+				
      
 					
 					
      executeAndReport
      
-					
        
-						
      • executeAndReport(resultFuture: Future, command: function): CircuitBreaker
        • 
+					
          
+						
        • executeAndReport<T>(resultFuture: Future<T>, command: function): CircuitBreaker
          • 
 					
        
 					
          
 						
        • 
 							
 							
          
 								
          
-									
           Same as {@link #executeAndReportWithFallback(Future, Handler, Function)} but using the circuit breaker default
+									
          Same as {@link #executeAndReportWithFallback(Future, Handler, Function)} but using the circuit breaker default
 									fallback.
          
 								
          
 							
          
+							
          Type parameters
          
+							
            
+								
          • 
+									
            T
            
+									
            
+										
            the type of result
            
+									
            
+								
            • 
+							
          
 							
          Parameters
          
 							
            
 								
          • 
-									
            resultFuture: Future
            
+									
            resultFuture: Future<T>
            
 									
            
 										
            the future on which the operation result is reported
            
 									
            
@@ -262,17 +287,20 @@ 
            command: function
            
 									
              
 										
            • 
 											
                
-												
              • (result: Future): void
                • 
+												
              • (res: Future<T>): void | Handler<Future<T>>
                • 
 											
              
 											
                
 												
              • 
 													
                Parameters
                
 													
                  
 														
                • 
-															
                  result: Future
                  
+															
                  res: Future<T>
                  
 														
                  • 
 													
                
-													
                Returns void
                
+													
                Returns void
+														 | 
+														Handler<Future<T>>
+													
                
 												
                • 
 											
              
 										
              • 
@@ -284,22 +312,22 @@ 
              Returns 
+				
              
 					
 					
              executeAndReportWithFallback
              
-					
                
-						
              • executeAndReportWithFallback(resultFuture: Future, command: function, fallback: function): CircuitBreaker
                • 
+					
                  
+						
                • executeAndReportWithFallback<T>(resultFuture: Future<T>, command: function, fallback: function): CircuitBreaker
                  • 
 					
                
 					
                  
 						
                • 
 							
 							
                  
 								
                  
-									
                   Executes the given operation with the circuit breaker control. The operation is generally calling an
+									
                  Executes the given operation with the circuit breaker control. The operation is generally calling an
 										external system. The operation receives a {@link Future} object as parameter and must
 										call {@link Future#complete(Object)} when the operation has terminated successfully. The operation must also
 										call {@link Future#fail(Throwable)} in case of failure.
@@ -314,10 +342,19 @@ 
                  executeAndReportWithFallback
                  
 											the future is marked as failed.
                  
 								
                  
 							
                  
+							
                  Type parameters
                  
+							
                    
+								
                  • 
+									
                    T
                    
+									
                    
+										
                    the type of result
                    
+									
                    
+								
                    • 
+							
                  
 							
                  Parameters
                  
 							
                    
 								
                  • 
-									
                    resultFuture: Future
                    
+									
                    resultFuture: Future<T>
                    
 									
                    
 										
                    the future on which the operation result is reported
                    
 									
                    
@@ -330,17 +367,20 @@ 
                    command: function
                    
 									
                      
 										
                    • 
 											
                        
-												
                      • (result: Future): void
                        • 
+												
                      • (res: Future<T>): void | Handler<Future<T>>
                        • 
 											
                      
 											
                        
 												
                      • 
 													
                        Parameters
                        
 													
                          
 														
                        • 
-															
                          result: Future
                          
+															
                          res: Future<T>
                          
 														
                          • 
 													
                        
-													
                        Returns void
                        
+													
                        Returns void
+														 | 
+														Handler<Future<T>>
+													
                        
 												
                        • 
 											
                      
 										
                      • 
@@ -354,17 +394,17 @@ 
                      fallback: function
                      
 									
                        
 										
                      • 
 											
                          
-												
                        • (t: Error): any
                          • 
+												
                        • (arg: Error): T
                          • 
 											
                        
 											
                          
 												
                        • 
 													
                          Parameters
                          
 													
                            
 														
                          • 
-															
                            t: Error
                            
+															
                            arg: Error
                            
 														
                            • 
 													
                          
-													
                          Returns any
                          
+													
                          Returns T
                          
 												
                          • 
 											
                        
 										
                        • 
@@ -376,24 +416,33 @@ 
                        Returns 
+				
                        
 					
 					
                        executeCommand
                        
-					
                          
-						
                        • executeCommand(command: function, handler: function): void
                          • 
+					
                            
+						
                          • executeCommand<T>(command: function, handler: function): void
                            • 
 					
                          
 					
                            
 						
                          • 
 							
 							
                            
 								
                            
-									
                             Same as {@link #executeWithFallback(Handler, Function)} but using the circuit breaker default fallback.
                            
+									
                            Same as {@link #executeWithFallback(Handler, Function)} but using the circuit breaker default fallback.
                            
 								
                            
 							
                            
+							
                            Type parameters
                            
+							
                              
+								
                            • 
+									
                              T
                              
+									
                              
+										
                              the type of result
                              
+									
                              
+								
                              • 
+							
                            
 							
                            Parameters
                            
 							
                              
 								
                            • 
@@ -404,17 +453,20 @@ 
                              command: function
                              
 									
                                
 										
                              • 
 											
                                  
-												
                                • (result: Future): void
                                  • 
+												
                                • (res: Future<T>): void | Handler<Future<T>>
                                  • 
 											
                                
 											
                                  
 												
                                • 
 													
                                  Parameters
                                  
 													
                                    
 														
                                  • 
-															
                                    result: Future
                                    
+															
                                    res: Future<T>
                                    
 														
                                    • 
 													
                                  
-													
                                  Returns void
                                  
+													
                                  Returns void
+														 | 
+														Handler<Future<T>>
+													
                                  
 												
                                  • 
 											
                                
 										
                                • 
@@ -425,17 +477,20 @@ 
                                handler: function
                                
 									
                                  
 										
                                • 
 											
                                    
-												
                                  • (result: AsyncResult<any>): void
                                    • 
+												
                                  • (res: AsyncResult<T>): void | Handler<AsyncResult<T>>
                                    • 
 											
                                  
 											
                                    
 												
                                  • 
 													
                                    Parameters
                                    
 													
                                      
 														
                                    • 
-															
                                      result: AsyncResult<any>
                                      
+															
                                      res: AsyncResult<T>
                                      
 														
                                      • 
 													
                                    
-													
                                    Returns void
                                    
+													
                                    Returns void
+														 | 
+														Handler<AsyncResult<T>>
+													
                                    
 												
                                    • 
 											
                                  
 										
                                  • 
@@ -447,24 +502,33 @@ 
                                  Returns void
 					
                                
 				
                        
-				
                        
+				
                        
 					
 					
                        executeCommandWithFallback
                        
-					
                          
-						
                        • executeCommandWithFallback(command: function, fallback: function, handler: function): void
                          • 
+					
                            
+						
                          • executeCommandWithFallback<T>(command: function, fallback: function, handler: function): void
                            • 
 					
                          
 					
                            
 						
                          • 
 							
 							
                            
 								
                            
-									
                             Same as {@link #executeWithFallback(Handler, Function)} but using a callback.
                            
+									
                            Same as {@link #executeWithFallback(Handler, Function)} but using a callback.
                            
 								
                            
 							
                            
+							
                            Type parameters
                            
+							
                              
+								
                            • 
+									
                              T
                              
+									
                              
+										
                              the type of result
                              
+									
                              
+								
                              • 
+							
                            
 							
                            Parameters
                            
 							
                              
 								
                            • 
@@ -475,17 +539,20 @@ 
                              command: function
                              
 									
                                
 										
                              • 
 											
                                  
-												
                                • (result: Future): void
                                  • 
+												
                                • (res: Future<T>): void | Handler<Future<T>>
                                  • 
 											
                                
 											
                                  
 												
                                • 
 													
                                  Parameters
                                  
 													
                                    
 														
                                  • 
-															
                                    result: Future
                                    
+															
                                    res: Future<T>
                                    
 														
                                    • 
 													
                                  
-													
                                  Returns void
                                  
+													
                                  Returns void
+														 | 
+														Handler<Future<T>>
+													
                                  
 												
                                  • 
 											
                                
 										
                                • 
@@ -499,17 +566,17 @@ 
                                fallback: function
                                
 									
                                  
 										
                                • 
 											
                                    
-												
                                  • (t: Error): any
                                    • 
+												
                                  • (arg: Error): T
                                    • 
 											
                                  
 											
                                    
 												
                                  • 
 													
                                    Parameters
                                    
 													
                                      
 														
                                    • 
-															
                                      t: Error
                                      
+															
                                      arg: Error
                                      
 														
                                      • 
 													
                                    
-													
                                    Returns any
                                    
+													
                                    Returns T
                                    
 												
                                    • 
 											
                                  
 										
                                  • 
@@ -525,17 +592,20 @@ 
                                  handler: function
                                  
 									
                                    
 										
                                  • 
 											
                                      
-												
                                    • (result: AsyncResult<any>): void
                                      • 
+												
                                    • (res: AsyncResult<T>): void | Handler<AsyncResult<T>>
                                      • 
 											
                                    
 											
                                      
 												
                                    • 
 													
                                      Parameters
                                      
 													
                                        
 														
                                      • 
-															
                                        result: AsyncResult<any>
                                        
+															
                                        res: AsyncResult<T>
                                        
 														
                                        • 
 													
                                      
-													
                                      Returns void
                                      
+													
                                      Returns void
+														 | 
+														Handler<AsyncResult<T>>
+													
                                      
 												
                                      • 
 											
                                    
 										
                                    • 
@@ -547,22 +617,22 @@ 
                                    Returns void
 					
                                  
 				
                        
-				
                        
+				
                        
 					
 					
                        executeWithFallback
                        
-					
                          
-						
                        • executeWithFallback(command: function, fallback: function): Future
                          • 
+					
                            
+						
                          • executeWithFallback<T>(command: function, fallback: function): Future<T>
                            • 
 					
                          
 					
                            
 						
                          • 
 							
 							
                            
 								
                            
-									
                             Executes the given operation with the circuit breaker control. The operation is generally calling an
+									
                            Executes the given operation with the circuit breaker control. The operation is generally calling an
 										external system. The operation receives a {@link Future} object as parameter and must
 										call {@link Future#complete(Object)} when the operation has terminated successfully. The operation must also
 										call {@link Future#fail(Throwable)} in case of failure.
@@ -576,6 +646,15 @@ 
                            executeWithFallback
                            
 											value returned from the fallback. If the fallback throws an exception, the returned future is marked as failed.
                            
 								
                            
 							
                            
+							
                            Type parameters
                            
+							
                              
+								
                            • 
+									
                              T
                              
+									
                              
+										
                              the type of result
                              
+									
                              
+								
                              • 
+							
                            
 							
                            Parameters
                            
 							
                              
 								
                            • 
@@ -586,17 +665,20 @@ 
                              command: function
                              
 									
                                
 										
                              • 
 											
                                  
-												
                                • (result: Future): void
                                  • 
+												
                                • (res: Future<T>): void | Handler<Future<T>>
                                  • 
 											
                                
 											
                                  
 												
                                • 
 													
                                  Parameters
                                  
 													
                                    
 														
                                  • 
-															
                                    result: Future
                                    
+															
                                    res: Future<T>
                                    
 														
                                    • 
 													
                                  
-													
                                  Returns void
                                  
+													
                                  Returns void
+														 | 
+														Handler<Future<T>>
+													
                                  
 												
                                  • 
 											
                                
 										
                                • 
@@ -610,24 +692,24 @@ 
                                fallback: function
                                
 									
                                  
 										
                                • 
 											
                                    
-												
                                  • (t: Error): any
                                    • 
+												
                                  • (arg: Error): T
                                    • 
 											
                                  
 											
                                    
 												
                                  • 
 													
                                    Parameters
                                    
 													
                                      
 														
                                    • 
-															
                                      t: Error
                                      
+															
                                      arg: Error
                                      
 														
                                      • 
 													
                                    
-													
                                    Returns any
                                    
+													
                                    Returns T
                                    
 												
                                    • 
 											
                                  
 										
                                  • 
 									
                                
 								
 							
                              
-							
                              Returns Future
                              
+							
                              Returns Future<T>
                              
 							
                              a future object completed when the operation or its fallback completes
                              
 						
                              • 
 					
                            
@@ -642,7 +724,7 @@ 
                            failureCount
                            
 						
                          • 
 							
 							
                            
@@ -652,27 +734,33 @@ 
                            Returns number
 					
                          
 				
                        
-				
                        
+				
                        
 					
 					
                        fallback
                        
-					
                          
-						
                        • fallback(handler: function): CircuitBreaker
                          • 
+					
 					
                            
 						
                          • 
 							
 							
                            
 								
                            
-									
                             Sets a default {@link Function} invoked when the bridge is open to handle the "request", or on failure
+									
                            Sets a default {@link Function} invoked when the bridge is open to handle the "request", or on failure
 										if {@link CircuitBreakerOptions#isFallbackOnFailure()} is enabled.
 										
                            
 										The function gets the exception as parameter and returns the fallback result.
                            
 								
                            
 							
                            
+							
                            Type parameters
                            
+							
                              
+								
                            • 
+									
                              T
                              
+								
                              • 
+							
                            
 							
                            Parameters
                            
 							
                              
 								
                            • 
@@ -683,17 +771,17 @@ 
                              handler: function
                              
 									
                                
 										
                              • 
 											
                                  
-												
                                • (t: Error): any
                                  • 
+												
                                • (arg: Error): T
                                  • 
 											
                                
 											
                                  
 												
                                • 
 													
                                  Parameters
                                  
 													
                                    
 														
                                  • 
-															
                                    t: Error
                                    
+															
                                    arg: Error
                                    
 														
                                    • 
 													
                                  
-													
                                  Returns any
                                  
+													
                                  Returns T
                                  
 												
                                  • 
 											
                                
 										
                                • 
@@ -715,12 +803,12 @@ 
                                halfOpenHandler
                                
 						
                              • 
 							
 							
                                
 								
                                
-									
                                 Sets a {@link Handler} invoked when the circuit breaker state switches to half-open.
                                
+									
                                Sets a {@link Handler} invoked when the circuit breaker state switches to half-open.
                                
 								
                                
 							
                                
 							
                                Parameters
                                
@@ -733,17 +821,20 @@ 
                                handler: function
                                
 									
                                  
 										
                                • 
 											
                                    
-												
                                  • (result: void): void
                                    • 
+												
                                  • (res: void): void | Handler<void>
                                    • 
 											
                                  
 											
                                    
 												
                                  • 
 													
                                    Parameters
                                    
 													
                                      
 														
                                    • 
-															
                                      result: void
                                      
+															
                                      res: void
                                      
 														
                                      • 
 													
                                    
-													
                                    Returns void
                                    
+													
                                    Returns void
+														 | 
+														Handler<void>
+													
                                    
 												
                                    • 
 											
                                  
 										
                                  • 
@@ -765,7 +856,7 @@ 
                                  name
                                  
 						
                                • 
 							
 							
                                  
@@ -785,12 +876,12 @@ 
                                  open
                                  
 						
                                • 
 							
 							
                                  
 								
                                  
-									
                                   Explicitly opens the circuit.
                                  
+									
                                  Explicitly opens the circuit.
                                  
 								
                                  
 							
                                  
 							
                                  Returns CircuitBreaker
                                  
@@ -808,12 +899,12 @@ 
                                  openHandler
                                  
 						
                                • 
 							
 							
                                  
 								
                                  
-									
                                   Sets a {@link Handler} invoked when the circuit breaker state switches to open.
                                  
+									
                                  Sets a {@link Handler} invoked when the circuit breaker state switches to open.
                                  
 								
                                  
 							
                                  
 							
                                  Parameters
                                  
@@ -826,17 +917,20 @@ 
                                  handler: function
                                  
 									
                                    
 										
                                  • 
 											
                                      
-												
                                    • (result: void): void
                                      • 
+												
                                    • (res: void): void | Handler<void>
                                      • 
 											
                                    
 											
                                      
 												
                                    • 
 													
                                      Parameters
                                      
 													
                                        
 														
                                      • 
-															
                                        result: void
                                        
+															
                                        res: void
                                        
 														
                                        • 
 													
                                      
-													
                                      Returns void
                                      
+													
                                      Returns void
+														 | 
+														Handler<void>
+													
                                      
 												
                                      • 
 											
                                    
 										
                                    • 
@@ -858,12 +952,12 @@ 
                                    reset
                                    
 						
                                  • 
 							
 							
                                    
 								
                                    
-									
                                     Resets the circuit breaker state (number of failure set to 0 and state set to closed).
                                    
+									
                                    Resets the circuit breaker state (number of failure set to 0 and state set to closed).
                                    
 								
                                    
 							
                                    
 							
                                    Returns CircuitBreaker
                                    
@@ -871,6 +965,47 @@ 
                                    Returns 
+					
+					
                                    retryPolicy
                                    
+					
+					
                                      
+						
                                    • 
+							
+							
                                      Parameters
                                      
+							
                                        
+								
                                      • 
+									
                                        retryPolicy: function
                                        
+									
                                          
+										
                                        • 
+											
                                            
+												
                                          • (arg: number): number
                                            • 
+											
                                          
+											
                                            
+												
                                          • 
+													
                                            Parameters
                                            
+													
                                              
+														
                                            • 
+															
                                              arg: number
                                              
+														
                                              • 
+													
                                            
+													
                                            Returns number
                                            
+												
                                            • 
+											
                                          
+										
                                          • 
+									
                                        
+								
                                        • 
+							
                                      
+							
                                      Returns CircuitBreaker
                                      
+						
                                      • 
+					
                                    
+				
                        
 				
                        
 					
 					
                        state
                        
@@ -881,7 +1016,7 @@ 
                        state
                        
 						
                      • 
 							
 							
                        
@@ -902,12 +1037,12 @@ 
                        Static create
                        
 						
                      • 
 							
 							
                        
 								
                        
-									
                         Creates a new instance of CircuitBreaker.
                        
+									
                        Creates a new instance of CircuitBreaker.
                        
 								
                        
 							
                        
 							
                        Parameters
                        
@@ -937,12 +1072,12 @@ 
                        Returns 
 							
 							
                        
 								
                        
-									
                         Creates a new instance of CircuitBreaker, with default options.
                        
+									
                        Creates a new instance of CircuitBreaker, with default options.
                        
 								
                        
 							
                        
 							
                        Parameters
                        
@@ -988,28 +1123,28 @@ 
                        Returns 
 								closeHandler
 							
                        • 
-							
                      • 
+							
                      • 
 								execute
 							
                        • 
-							
                      • 
+							
                      • 
 								executeAndReport
 							
                        • 
-							
                      • 
+							
                      • 
 								executeAndReportWithFallback
 							
                        • 
-							
                      • 
+							
                      • 
 								executeCommand
 							
                        • 
-							
                      • 
+							
                      • 
 								executeCommandWithFallback
 							
                        • 
-							
                      • 
+							
                      • 
 								executeWithFallback
 							
                        • 
 							
                      • 
 								failureCount
 							
                        • 
-							
                      • 
+							
                      • 
 								fallback
 							
                        • 
 							
                      • 
@@ -1027,6 +1162,9 @@ 
                        Returns 
 								reset
 							
                        • 
+							
                      • 
+								retryPolicy
+							
                        • 
 							
                      • 
 								state
 							
                        • 
diff --git a/docs/@vertx/circuit-breaker/classes/circuitbreakeroptions.html b/docs/@vertx/circuit-breaker/classes/circuitbreakeroptions.html
index 586925138..146013574 100644
--- a/docs/@vertx/circuit-breaker/classes/circuitbreakeroptions.html
+++ b/docs/@vertx/circuit-breaker/classes/circuitbreakeroptions.html
@@ -77,235 +77,629 @@ 
                        Index
                        
 				
                        
 					
                        
 						
                        
-							
                        Properties
                        
+							
                        Constructors
                        
 							
+						
                        
+						
                        
+							
                        Methods
                        
+							
 						
                        
 					
                        
 				
                        
 			
                        
 			
                        
-				
                        Properties
                        
-				
                        
-					
-					
                        fallbackOnFailure
                        
-					
                        fallbackOnFailure: boolean
                        
-					
-					
                        
-						
                        
-							
                        Sets whether or not the fallback is executed on failure, even when the circuit is closed.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        to enable it.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        Constructors
                        
+				
                        
+					
+					
                        constructor
                        
+					
+					
 				
                        
-				
                        
-					
-					
                        maxFailures
                        
-					
                        maxFailures: number
                        
-					
-					
                        
-						
                        
-							
                        Sets the maximum number of failures before opening the circuit.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the number of failures.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+			
                        
+			
                        
+				
                        Methods
                        
+				
                        
+					
+					
                        getFailuresRollingWindow
                        
+					
                          
+						
                        • getFailuresRollingWindow(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the rolling window used for metrics.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        maxRetries
                        
-					
                        maxRetries: number
                        
-					
-					
                        
-						
                        
-							
                        Configures the number of times the circuit breaker tries to redo the operation before failing.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the number of retries, 0 to disable this feature.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getMaxFailures
                        
+					
                          
+						
                        • getMaxFailures(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the maximum number of failures before opening the circuit.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        metricsRollingBuckets
                        
-					
                        metricsRollingBuckets: number
                        
-					
-					
                        
-						
                        
-							
                        Sets the configured number of buckets the rolling window is divided into.
                        
-						
                        
-						
                         The following must be true - metrics.rollingStats.timeInMilliseconds % metrics.rollingStats.numBuckets == 0 - otherwise it will throw an exception.
                        
-						
                         In other words, 10000/10 is okay, so is 10000/20 but 10000/7 is not.
                        
-						
                        
-							
                        param
                        
-							
                        the number of rolling buckets.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getMaxRetries
                        
+					
                          
+						
                        • getMaxRetries(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Configures the number of times the circuit breaker tries to redo the operation before failing.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        metricsRollingWindow
                        
-					
                        metricsRollingWindow: number
                        
-					
-					
                        
-						
                        
-							
                        Sets the rolling window used for metrics.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the period in milliseconds.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getMetricsRollingBuckets
                        
+					
                          
+						
                        • getMetricsRollingBuckets(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the configured number of buckets the rolling window is divided into.
                          
+								
                          
+								
                           The following must be true - metrics.rollingStats.timeInMilliseconds % metrics.rollingStats.numBuckets == 0 - otherwise it will throw an exception.
                          
+								
                           In other words, 10000/10 is okay, so is 10000/20 but 10000/7 is not.
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        notificationAddress
                        
-					
                        notificationAddress: string
                        
-					
-					
                        
-						
                        
-							
                        Sets the event bus address on which the circuit breaker publish its state change.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the address, {@code null} to disable this feature.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getMetricsRollingWindow
                        
+					
                          
+						
                        • getMetricsRollingWindow(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the rolling window used for metrics.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        notificationPeriod
                        
-					
                        notificationPeriod: number
                        
-					
-					
                        
-						
                        
-							
                        Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its
-							current state.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the period, 0 to disable this feature.
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getNotificationAddress
                        
+					
                          
+						
                        • getNotificationAddress(): string
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the event bus address on which the circuit breaker publish its state change.
                          
+								
                          
+							
                          
+							
                          Returns string
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        resetTimeout
                        
-					
                        resetTimeout: number
                        
-					
-					
                        
-						
                        
-							
                        Sets the time in ms before it attempts to re-close the circuit (by going to the half-open state). If the circuit
-							is closed when the timeout is reached, nothing happens. {@code -1} disables this feature.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the time in ms
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getNotificationPeriod
                        
+					
                          
+						
                        • getNotificationPeriod(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its
+									current state.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
 				
                        
-				
                        
-					
-					
                        timeout
                        
-					
                        timeout: number
                        
-					
-					
                        
-						
                        
-							
                        Sets the timeout in milliseconds. If an action is not completed before this timeout, the action is considered as
-							a failure.
                        
-						
                        
-						
                        
-							
                        param
                        
-							
                        the timeout, -1 to disable the timeout
                        
-							
                        
-							
                        returns
                        
-							
                        the current CircuitBreakerOptions instance
                        
-							
                        
-						
                        
-					
                        
+				
                        
+					
+					
                        getResetTimeout
                        
+					
                          
+						
                        • getResetTimeout(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the time in ms before it attempts to re-close the circuit (by going to the half-open state). If the circuit
+									is closed when the timeout is reached, nothing happens. {@code -1} disables this feature.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        getTimeout
                        
+					
                          
+						
                        • getTimeout(): number
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the timeout in milliseconds. If an action is not completed before this timeout, the action is considered as
+									a failure.
                          
+								
                          
+							
                          
+							
                          Returns number
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        isFallbackOnFailure
                        
+					
                          
+						
                        • isFallbackOnFailure(): boolean
                          • 
+					
                        
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets whether or not the fallback is executed on failure, even when the circuit is closed.
                          
+								
                          
+							
                          
+							
                          Returns boolean
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setFailuresRollingWindow
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the rolling window used for metrics.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            failuresRollingWindow: number
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setFallbackOnFailure
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets whether or not the fallback is executed on failure, even when the circuit is closed.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            fallbackOnFailure: boolean
                            
+									
                            
+										
                            to enable it.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setMaxFailures
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the maximum number of failures before opening the circuit.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            maxFailures: number
                            
+									
                            
+										
                            the number of failures.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setMaxRetries
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Configures the number of times the circuit breaker tries to redo the operation before failing.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            maxRetries: number
                            
+									
                            
+										
                            the number of retries, 0 to disable this feature.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setMetricsRollingBuckets
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the configured number of buckets the rolling window is divided into.
                          
+								
                          
+								
                           The following must be true - metrics.rollingStats.timeInMilliseconds % metrics.rollingStats.numBuckets == 0 - otherwise it will throw an exception.
                          
+								
                           In other words, 10000/10 is okay, so is 10000/20 but 10000/7 is not.
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            metricsRollingBuckets: number
                            
+									
                            
+										
                            the number of rolling buckets.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setMetricsRollingWindow
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the rolling window used for metrics.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            metricsRollingWindow: number
                            
+									
                            
+										
                            the period in milliseconds.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setNotificationAddress
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the event bus address on which the circuit breaker publish its state change.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            notificationAddress: string
                            
+									
                            
+										
                            the address, {@code null} to disable this feature.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setNotificationPeriod
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its
+									current state.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            notificationPeriod: number
                            
+									
                            
+										
                            the period, 0 to disable this feature.
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setResetTimeout
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the time in ms before it attempts to re-close the circuit (by going to the half-open state). If the circuit
+									is closed when the timeout is reached, nothing happens. {@code -1} disables this feature.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            resetTimeout: number
                            
+									
                            
+										
                            the time in ms
                            
+									
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+					
                        
+				
                        
+				
                        
+					
+					
                        setTimeout
                        
+					
+					
                          
+						
                        • 
+							
+							
                          
+								
                          
+									
                          Sets the timeout in milliseconds. If an action is not completed before this timeout, the action is considered as
+									a failure.
                          
+								
                          
+							
                          
+							
                          Parameters
                          
+							
                            
+								
                          • 
+									
                            timeout: number
                            
+								
                            • 
+							
                          
+							
                          Returns CircuitBreakerOptions
                          
+							
                          the current CircuitBreakerOptions instance
                          
+						
                          • 
+
    • @@ -327,32 +721,68 @@

    timeout

  • CircuitBreakerOptions
    • diff --git a/docs/@vertx/circuit-breaker/classes/hystrixmetrichandler.html b/docs/@vertx/circuit-breaker/classes/hystrixmetrichandler.html index 955b04161..8b022e4b3 100644 --- a/docs/@vertx/circuit-breaker/classes/hystrixmetrichandler.html +++ b/docs/@vertx/circuit-breaker/classes/hystrixmetrichandler.html @@ -72,6 +72,12 @@

    Hierarchy

    +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -98,7 +104,7 @@

    handle

  • Parameters

    @@ -122,12 +128,12 @@

    Static create

  • -

    Creates the handler, using the default notification address.

    +

    Creates the handler, using the default notification address.

    Parameters

    @@ -145,12 +151,12 @@

    Returns
    -

    Creates the handler.

    +

    Creates the handler.

    Parameters

    diff --git a/docs/@vertx/cofig-redis/index.html b/docs/@vertx/cofig-redis/index.html index 1ee33f28d..e91d3a714 100644 --- a/docs/@vertx/cofig-redis/index.html +++ b/docs/@vertx/cofig-redis/index.html @@ -62,6 +62,39 @@

    @vertx/cofig-redis

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    +     +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-consul/index.html b/docs/@vertx/config-consul/index.html index f97768dcd..d7afec63c 100644 --- a/docs/@vertx/config-consul/index.html +++ b/docs/@vertx/config-consul/index.html @@ -62,6 +62,39 @@

    @vertx/config-consul

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-git/index.html b/docs/@vertx/config-git/index.html index f7fba9036..1289d187e 100644 --- a/docs/@vertx/config-git/index.html +++ b/docs/@vertx/config-git/index.html @@ -62,6 +62,39 @@

    @vertx/config-git

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-hocon/index.html b/docs/@vertx/config-hocon/index.html index 664b9ee61..4dd531409 100644 --- a/docs/@vertx/config-hocon/index.html +++ b/docs/@vertx/config-hocon/index.html @@ -62,6 +62,39 @@

    @vertx/config-hocon

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-kubernetes-configmap/index.html b/docs/@vertx/config-kubernetes-configmap/index.html index 846be6772..2417567ef 100644 --- a/docs/@vertx/config-kubernetes-configmap/index.html +++ b/docs/@vertx/config-kubernetes-configmap/index.html @@ -62,6 +62,39 @@

    @vertx/config-kubernetes-configmap

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-spring-config-server/index.html b/docs/@vertx/config-spring-config-server/index.html index 9945493a3..20ba23af2 100644 --- a/docs/@vertx/config-spring-config-server/index.html +++ b/docs/@vertx/config-spring-config-server/index.html @@ -62,6 +62,39 @@

    @vertx/config-spring-config-server

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-vault/assets/js/search.js b/docs/@vertx/config-vault/assets/js/search.js index f2f1b11f9..efcdebfe4 100644 --- a/docs/@vertx/config-vault/assets/js/search.js +++ b/docs/@vertx/config-vault/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property"},"rows":[{"id":0,"kind":128,"name":"TokenRequest","url":"classes/tokenrequest.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"displayName","url":"classes/tokenrequest.html#displayname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":2,"kind":1024,"name":"id","url":"classes/tokenrequest.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":3,"kind":1024,"name":"meta","url":"classes/tokenrequest.html#meta","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":4,"kind":1024,"name":"noDefaultPolicy","url":"classes/tokenrequest.html#nodefaultpolicy","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":5,"kind":1024,"name":"noParent","url":"classes/tokenrequest.html#noparent","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":6,"kind":1024,"name":"numUses","url":"classes/tokenrequest.html#numuses","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":7,"kind":1024,"name":"policies","url":"classes/tokenrequest.html#policies","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":8,"kind":1024,"name":"role","url":"classes/tokenrequest.html#role","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"},{"id":9,"kind":1024,"name":"ttl","url":"classes/tokenrequest.html#ttl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TokenRequest"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"TokenRequest","url":"classes/tokenrequest.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/tokenrequest.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TokenRequest"},{"id":2,"kind":2048,"name":"getDisplayName","url":"classes/tokenrequest.html#getdisplayname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":3,"kind":2048,"name":"setDisplayName","url":"classes/tokenrequest.html#setdisplayname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":4,"kind":2048,"name":"getId","url":"classes/tokenrequest.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":5,"kind":2048,"name":"setId","url":"classes/tokenrequest.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":6,"kind":2048,"name":"getMeta","url":"classes/tokenrequest.html#getmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":7,"kind":2048,"name":"setMeta","url":"classes/tokenrequest.html#setmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":8,"kind":2048,"name":"isNoDefaultPolicy","url":"classes/tokenrequest.html#isnodefaultpolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":9,"kind":2048,"name":"setNoDefaultPolicy","url":"classes/tokenrequest.html#setnodefaultpolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":10,"kind":2048,"name":"isNoParent","url":"classes/tokenrequest.html#isnoparent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":11,"kind":2048,"name":"setNoParent","url":"classes/tokenrequest.html#setnoparent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":12,"kind":2048,"name":"getNumUses","url":"classes/tokenrequest.html#getnumuses","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":13,"kind":2048,"name":"setNumUses","url":"classes/tokenrequest.html#setnumuses","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":14,"kind":2048,"name":"getPolicies","url":"classes/tokenrequest.html#getpolicies","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":15,"kind":2048,"name":"setPolicies","url":"classes/tokenrequest.html#setpolicies","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":16,"kind":2048,"name":"getRole","url":"classes/tokenrequest.html#getrole","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":17,"kind":2048,"name":"setRole","url":"classes/tokenrequest.html#setrole","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":18,"kind":2048,"name":"getTtl","url":"classes/tokenrequest.html#getttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"},{"id":19,"kind":2048,"name":"setTTL","url":"classes/tokenrequest.html#setttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TokenRequest"}]}; \ No newline at end of file diff --git a/docs/@vertx/config-vault/classes/tokenrequest.html b/docs/@vertx/config-vault/classes/tokenrequest.html index d55a87da0..0748e60c5 100644 --- a/docs/@vertx/config-vault/classes/tokenrequest.html +++ b/docs/@vertx/config-vault/classes/tokenrequest.html @@ -77,113 +77,433 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +

    • -

    Properties

    -
    - -

    displayName

    -
    displayName: string
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    id

    -
    id: string
    - +
    +
    +

    Methods

    +
    + +

    getDisplayName

    +
      +
    • getDisplayName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    meta

    -
    meta: string
    - +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    noDefaultPolicy

    -
    noDefaultPolicy: boolean
    - +
    + +

    getMeta

    +
      +
    • getMeta(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    noParent

    -
    noParent: boolean
    - +
    + +

    getNumUses

    +
      +
    • getNumUses(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    numUses

    -
    numUses: number
    - +
    + +

    getPolicies

    +
      +
    • getPolicies(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    policies

    -
    policies: string
    - +
    + +

    getRole

    +
      +
    • getRole(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    role

    -
    role: string
    - +
    + +

    getTtl

    +
      +
    • getTtl(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    ttl

    -
    ttl: string
    - +
    + +

    isNoDefaultPolicy

    +
      +
    • isNoDefaultPolicy(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isNoParent

    +
      +
    • isNoParent(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setDisplayName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        displayName: string
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        id: string
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setMeta

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        meta: string
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setNoDefaultPolicy

    +
      +
    • setNoDefaultPolicy(noDefaultPolicy: boolean): TokenRequest
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        noDefaultPolicy: boolean
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setNoParent

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        noParent: boolean
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setNumUses

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        numUses: number
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setPolicies

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        policies: string
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setRole

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        role: string
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    +
    +
    + +

    setTTL

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ttl: string
        +
        • +
      +

      Returns TokenRequest

      +
      • +
    @@ -202,32 +522,62 @@

    ttl

  • TokenRequest
    • diff --git a/docs/@vertx/config-yaml/index.html b/docs/@vertx/config-yaml/index.html index 22226b698..72a3622f6 100644 --- a/docs/@vertx/config-yaml/index.html +++ b/docs/@vertx/config-yaml/index.html @@ -62,6 +62,39 @@

    @vertx/config-yaml

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config-zookeeper/index.html b/docs/@vertx/config-zookeeper/index.html index 8e6f6bf96..1c42bab84 100644 --- a/docs/@vertx/config-zookeeper/index.html +++ b/docs/@vertx/config-zookeeper/index.html @@ -62,6 +62,39 @@

    @vertx/config-zookeeper

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/config');
+// Base ENUMs
+const Enums = require('@vertx/config/enums');
+// DataObject's
+const Options = require('@vertx/config/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/config/assets/js/search.js b/docs/@vertx/config/assets/js/search.js index 460d85c93..51e928d93 100644 --- a/docs/@vertx/config/assets/js/search.js +++ b/docs/@vertx/config/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"ConfigChange","url":"classes/configchange.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"newConfiguration","url":"classes/configchange.html#newconfiguration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigChange"},{"id":2,"kind":1024,"name":"previousConfiguration","url":"classes/configchange.html#previousconfiguration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigChange"},{"id":3,"kind":128,"name":"ConfigRetrieverOptions","url":"classes/configretrieveroptions.html","classes":"tsd-kind-class"},{"id":4,"kind":1024,"name":"includeDefaultStores","url":"classes/configretrieveroptions.html#includedefaultstores","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":5,"kind":1024,"name":"scanPeriod","url":"classes/configretrieveroptions.html#scanperiod","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":6,"kind":1024,"name":"stores","url":"classes/configretrieveroptions.html#stores","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":7,"kind":128,"name":"ConfigStoreOptions","url":"classes/configstoreoptions.html","classes":"tsd-kind-class"},{"id":8,"kind":1024,"name":"config","url":"classes/configstoreoptions.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":9,"kind":1024,"name":"format","url":"classes/configstoreoptions.html#format","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":10,"kind":1024,"name":"optional","url":"classes/configstoreoptions.html#optional","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":11,"kind":1024,"name":"type","url":"classes/configstoreoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":12,"kind":128,"name":"ConfigRetriever","url":"classes/configretriever.html","classes":"tsd-kind-class"},{"id":13,"kind":2048,"name":"create","url":"classes/configretriever.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ConfigRetriever"},{"id":14,"kind":2048,"name":"getConfigAsFuture","url":"classes/configretriever.html#getconfigasfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ConfigRetriever"},{"id":15,"kind":2048,"name":"getConfig","url":"classes/configretriever.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":16,"kind":2048,"name":"close","url":"classes/configretriever.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":17,"kind":2048,"name":"getCachedConfig","url":"classes/configretriever.html#getcachedconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":18,"kind":2048,"name":"listen","url":"classes/configretriever.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":19,"kind":2048,"name":"configStream","url":"classes/configretriever.html#configstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":128,"name":"ConfigChange","url":"classes/configchange.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/configchange.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ConfigChange"},{"id":2,"kind":2048,"name":"getNewConfiguration","url":"classes/configchange.html#getnewconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigChange"},{"id":3,"kind":2048,"name":"setNewConfiguration","url":"classes/configchange.html#setnewconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigChange"},{"id":4,"kind":2048,"name":"getPreviousConfiguration","url":"classes/configchange.html#getpreviousconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigChange"},{"id":5,"kind":2048,"name":"setPreviousConfiguration","url":"classes/configchange.html#setpreviousconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigChange"},{"id":6,"kind":128,"name":"ConfigRetrieverOptions","url":"classes/configretrieveroptions.html","classes":"tsd-kind-class"},{"id":7,"kind":512,"name":"constructor","url":"classes/configretrieveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":8,"kind":2048,"name":"isIncludeDefaultStores","url":"classes/configretrieveroptions.html#isincludedefaultstores","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":9,"kind":2048,"name":"setIncludeDefaultStores","url":"classes/configretrieveroptions.html#setincludedefaultstores","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":10,"kind":2048,"name":"getScanPeriod","url":"classes/configretrieveroptions.html#getscanperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":11,"kind":2048,"name":"setScanPeriod","url":"classes/configretrieveroptions.html#setscanperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":12,"kind":2048,"name":"getStores","url":"classes/configretrieveroptions.html#getstores","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":13,"kind":2048,"name":"setStores","url":"classes/configretrieveroptions.html#setstores","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":14,"kind":2048,"name":"addStore","url":"classes/configretrieveroptions.html#addstore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetrieverOptions"},{"id":15,"kind":128,"name":"ConfigStoreOptions","url":"classes/configstoreoptions.html","classes":"tsd-kind-class"},{"id":16,"kind":512,"name":"constructor","url":"classes/configstoreoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":17,"kind":2048,"name":"getConfig","url":"classes/configstoreoptions.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":18,"kind":2048,"name":"setConfig","url":"classes/configstoreoptions.html#setconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":19,"kind":2048,"name":"getFormat","url":"classes/configstoreoptions.html#getformat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":20,"kind":2048,"name":"setFormat","url":"classes/configstoreoptions.html#setformat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":21,"kind":2048,"name":"isOptional","url":"classes/configstoreoptions.html#isoptional","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":22,"kind":2048,"name":"setOptional","url":"classes/configstoreoptions.html#setoptional","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":23,"kind":2048,"name":"getType","url":"classes/configstoreoptions.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":24,"kind":2048,"name":"setType","url":"classes/configstoreoptions.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigStoreOptions"},{"id":25,"kind":128,"name":"ConfigRetriever","url":"classes/configretriever.html","classes":"tsd-kind-class"},{"id":26,"kind":2048,"name":"create","url":"classes/configretriever.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ConfigRetriever"},{"id":27,"kind":2048,"name":"getConfigAsFuture","url":"classes/configretriever.html#getconfigasfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ConfigRetriever"},{"id":28,"kind":2048,"name":"getConfig","url":"classes/configretriever.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":29,"kind":2048,"name":"close","url":"classes/configretriever.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":30,"kind":2048,"name":"getCachedConfig","url":"classes/configretriever.html#getcachedconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":31,"kind":2048,"name":"listen","url":"classes/configretriever.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":32,"kind":2048,"name":"setBeforeScanHandler","url":"classes/configretriever.html#setbeforescanhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":33,"kind":1024,"name":"function","url":"classes/configretriever.html#function","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":34,"kind":65536,"name":"__type","url":"classes/configretriever.html#function.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"ConfigRetriever.function"},{"id":35,"kind":1024,"name":"ConfigRetriever","url":"classes/configretriever.html#configretriever-1","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":36,"kind":2048,"name":"setConfigurationProcessor","url":"classes/configretriever.html#setconfigurationprocessor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"},{"id":37,"kind":2048,"name":"configStream","url":"classes/configretriever.html#configstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConfigRetriever"}]}; \ No newline at end of file diff --git a/docs/@vertx/config/classes/configchange.html b/docs/@vertx/config/classes/configchange.html index bbe0b08b7..bfc0f2ce9 100644 --- a/docs/@vertx/config/classes/configchange.html +++ b/docs/@vertx/config/classes/configchange.html @@ -77,62 +77,183 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    newConfiguration

    -
    newConfiguration: object
    - -
    -
    -

    Sets the new configuration.

    -
    -
    -
    param
    -

    the new configuration, may be {@code null}. In this case, an empty JSON object is used.

    -
    -
    returns
    -

    the current instance of ConfigChange

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    previousConfiguration

    -
    previousConfiguration: object
    - -
    -
    -

    Sets the previous configuration.

    -
    -
    -
    param
    -

    the configuration, may be {@code null}. In this case an empty JSON object is used.

    -
    -
    returns
    -

    the current instance of ConfigChange

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getNewConfiguration

    +
      +
    • getNewConfiguration(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the new configuration.

      +
      +
      +

      Returns object

      +

      the current instance of ConfigChange

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    getPreviousConfiguration

    +
      +
    • getPreviousConfiguration(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the previous configuration.

      +
      +
      +

      Returns object

      +

      the current instance of ConfigChange

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    setNewConfiguration

    +
      +
    • setNewConfiguration(newConfiguration: object): ConfigChange
      • +
    +
      +
    • + +
      +
      +

      Sets the new configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        newConfiguration: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns ConfigChange

      +

      the current instance of ConfigChange

      +
      • +
    +
    +
    + +

    setPreviousConfiguration

    +
      +
    • setPreviousConfiguration(previousConfiguration: object): ConfigChange
      • +
    +
      +
    • + +
      +
      +

      Sets the previous configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        previousConfiguration: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns ConfigChange

      +

      the current instance of ConfigChange

      +
      • +
    @@ -151,11 +272,20 @@

    previousConfiguration

  • ConfigChange
    • diff --git a/docs/@vertx/config/classes/configretriever.html b/docs/@vertx/config/classes/configretriever.html index 2a184157d..b94f669c1 100644 --- a/docs/@vertx/config/classes/configretriever.html +++ b/docs/@vertx/config/classes/configretriever.html @@ -76,6 +76,13 @@

    Hierarchy

    Index

    +
    +

    Properties

    + +

    Methods

    @@ -91,6 +100,53 @@

    Methods

    +
    +

    Properties

    +
    + +

    ConfigRetriever

    +
    ConfigRetriever: any
    + +
    +
    + +

    function

    +
    function: function
    + +
    +

    Type declaration

    +
      +
    • +
        +
      • (res: void): void | Handler<void>
        • +
      +
        +
      • +

        Parameters

        +
          +
        • +
          res: void
          +
          • +
        +

        Returns void + | + Handler<void> +

        +
        • +
      +
      • +
    +
    +
    +

    Methods

    @@ -103,12 +159,12 @@

    close

  • -

    Closes the retriever.

    +

    Closes the retriever.

    Returns void

    @@ -119,18 +175,18 @@

    Returns void

    configStream

      -
    • configStream(): ReadStream
      • +
    • configStream(): ReadStream<object>
    • -

      Returns ReadStream

      +

      Returns ReadStream<object>

      the stream of configurations. It's single stream (unicast) and that delivers the last known config and the successors periodically.

      • @@ -146,16 +202,21 @@

      getCachedConfig

    • -

      Gets the last computed configuration.

      +

      Gets the last computed configuration.

      Returns object

      the last configuration

      +
        +
      • +
        [key: string]: any
        +
        • +

    • @@ -169,12 +230,12 @@

    getConfig

  • -

    Reads the configuration from the different {@link ConfigStore} +

    Reads the configuration from the different {@link ConfigStore} and computes the final configuration.

    @@ -189,17 +250,20 @@
    completionHandler: function
      • -
      • (result: AsyncResult<any>): void
        • +
      • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

      • Parameters

        • -
          result: AsyncResult<any>
          +
          res: AsyncResult<object>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<object>> +

      • @@ -220,12 +284,12 @@

      listen

    • -

      Registers a listener receiving configuration changes. This method cannot only be called if +

      Registers a listener receiving configuration changes. This method cannot only be called if the configuration is broadcasted.

      @@ -239,17 +303,20 @@
      listener: function
    • +
    + +

    setBeforeScanHandler

    +
      +
    • setBeforeScanHandler(): any
      • +
    +
      +
    • + +
      +
      +

      Registers a handler called before every scan. This method is mostly used for logging purpose.

      +
      +
      +

      Returns any

      +

      the current config retriever

      +
      • +
    +
    +
    + +

    setConfigurationProcessor

    + +
      +
    • + +
      +
      +

      Registers a handler that process the configuration before being injected into {@link #getConfig(Handler)} or {@link #listen(Handler)}. This allows + the code to customize the configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        processor: function
        +
        +

        the processor, must not be {@code null}. The method must not return {@code null}. The returned configuration is used. If the processor + does not update the configuration, it must return the input configuration. If the processor throws an exception, the failure is passed + to the {@link #getConfig(Handler)} handler.

        +
        +
          +
        • +
            +
          • (arg: object): object
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              arg: object
              +
                +
              • +
                [key: string]: any
                +
                • +
              +
              • +
            +

            Returns object

            +
              +
            • +
              [key: string]: any
              +
              • +
            +
            • +
          +
          • +
        +
        • +
      +

      Returns ConfigRetriever

      +

      the current config retriever

      +
      • +
    +

    Static create

    @@ -271,12 +424,12 @@

    Static create

  • -

    Creates an instance of the default implementation of the ConfigRetriever.

    +

    Creates an instance of the default implementation of the ConfigRetriever.

    Parameters

    @@ -300,12 +453,12 @@

    Returns
    -

    Creates an instance of the default implementation of the ConfigRetriever, using the default +

    Creates an instance of the default implementation of the ConfigRetriever, using the default settings (json file, system properties and environment variables).

    @@ -327,18 +480,18 @@

    Returns

    Static getConfigAsFuture

    • -

      Same as {@link ConfigRetriever#getConfig(Handler)}, but returning a {@link Future} object. The result is a +

      Same as {@link ConfigRetriever#getConfig(Handler)}, but returning a {@link Future} object. The result is a {@link JsonObject}.

      @@ -351,7 +504,7 @@
      retriever: ConfigR
    -

    Returns Future

    +

    Returns Future<object>

    the future completed when the configuration is retrieved

    • @@ -376,6 +529,12 @@

    Returns Future ConfigRetriever

    -

    Properties

    -
    - -

    includeDefaultStores

    -
    includeDefaultStores: boolean
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    scanPeriod

    -
    scanPeriod: number
    - +
    +
    +

    Methods

    +
    + +

    addStore

    + +
    -
    - -

    stores

    -
    stores: ConfigStoreOptions
    - +
    + +

    getScanPeriod

    +
      +
    • getScanPeriod(): number
      • +
    +
      +
    • + +
      +
      +

      Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.

      +
      +
      +

      Returns number

      +

      the current ConfigStoreOptions

      +
      • +
    +
    +
    + +

    getStores

    + + +
    +
    + +

    isIncludeDefaultStores

    +
      +
    • isIncludeDefaultStores(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enables or disables the inclusion of the default stored in the configuration.

      +
      +
      +

      Returns boolean

      +

      the current ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setIncludeDefaultStores

    + +
      +
    • + +
      +
      +

      Enables or disables the inclusion of the default stored in the configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        includeDefaultStores: boolean
        +
        +

        to include the default stores.

        +
        +
        • +
      +

      Returns ConfigRetrieverOptions

      +

      the current ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setScanPeriod

    + +
      +
    • + +
      +
      +

      Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.

      +
      +
      +

      Parameters

      +
        +
      • +
        scanPeriod: number
        +
        +

        the scan period in ms

        +
        +
        • +
      +

      Returns ConfigRetrieverOptions

      +

      the current ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setStores

    + +
    @@ -142,14 +354,29 @@

    stores

  • ConfigRetrieverOptions
    • diff --git a/docs/@vertx/config/classes/configstoreoptions.html b/docs/@vertx/config/classes/configstoreoptions.html index c98726bae..4a84ea284 100644 --- a/docs/@vertx/config/classes/configstoreoptions.html +++ b/docs/@vertx/config/classes/configstoreoptions.html @@ -77,111 +77,295 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    config

    -
    config: object
    - -
    -
    -

    Sets the configuration of the store

    -
    -
    -
    param
    -

    the data, can be {@code null}

    -
    -
    returns
    -

    the current instance of ConfigStoreOptions

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    format

    -
    format: string
    - -
    -
    -

    Sets the format of the configuration that is retrieved from the store.

    -
    -
    -
    param
    -

    the format, must not be {@code null}.

    -
    -
    returns
    -

    the current instance of ConfigStoreOptions

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getConfig

    +
      +
    • getConfig(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the configuration of the store

      +
      +
      +

      Returns object

      +

      the current instance of ConfigStoreOptions

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    optional

    -
    optional: boolean
    - -
    -
    -

    Sets whether or not the store is optional. When the configuration is retrieve, if an optional store - returns a failure, the failure is ignored and an empty json object is used instead (for this store).

    -
    -
    -
    param
    -

    whether or not the store is optional.

    -
    -
    returns
    -

    the current instance of ConfigStoreOptions

    -
    -
    -
    +
    + +

    getFormat

    +
      +
    • getFormat(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the format of the configuration that is retrieved from the store.

      +
      +
      +

      Returns string

      +

      the current instance of ConfigStoreOptions

      +
      • +
    -
    - -

    type

    -
    type: string
    - -
    -
    -

    Sets the configuration type

    -
    -
    -
    param
    -

    the type

    -
    -
    returns
    -

    the current instance of ConfigStoreOptions

    -
    -
    -
    +
    + +

    getType

    +
      +
    • getType(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the configuration type

      +
      +
      +

      Returns string

      +

      the current instance of ConfigStoreOptions

      +
      • +
    +
    +
    + +

    isOptional

    +
      +
    • isOptional(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the store is optional. When the configuration is retrieve, if an optional store + returns a failure, the failure is ignored and an empty json object is used instead (for this store).

      +
      +
      +

      Returns boolean

      +

      the current instance of ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setConfig

    + +
      +
    • + +
      +
      +

      Sets the configuration of the store

      +
      +
      +

      Parameters

      +
        +
      • +
        config: object
        +
        +

        the data, can be {@code null}

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns ConfigStoreOptions

      +

      the current instance of ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setFormat

    + +
      +
    • + +
      +
      +

      Sets the format of the configuration that is retrieved from the store.

      +
      +
      +

      Parameters

      +
        +
      • +
        format: string
        +
        +

        the format, must not be {@code null}.

        +
        +
        • +
      +

      Returns ConfigStoreOptions

      +

      the current instance of ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setOptional

    + +
      +
    • + +
      +
      +

      Sets whether or not the store is optional. When the configuration is retrieve, if an optional store + returns a failure, the failure is ignored and an empty json object is used instead (for this store).

      +
      +
      +

      Parameters

      +
        +
      • +
        optional: boolean
        +
        +

        whether or not the store is optional.

        +
        +
        • +
      +

      Returns ConfigStoreOptions

      +

      the current instance of ConfigStoreOptions

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +
      +
      +

      Sets the configuration type

      +
      +
      +

      Parameters

      +
        +
      • +
        type: string
        +
        +

        the type

        +
        +
        • +
      +

      Returns ConfigStoreOptions

      +

      the current instance of ConfigStoreOptions

      +
      • +
    @@ -209,17 +393,32 @@

    type

  • ConfigStoreOptions
    • diff --git a/docs/@vertx/consul-client/assets/js/search.js b/docs/@vertx/consul-client/assets/js/search.js index dea4868ce..0cdcc07e5 100644 --- a/docs/@vertx/consul-client/assets/js/search.js +++ b/docs/@vertx/consul-client/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"AclToken","url":"classes/acltoken.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"id","url":"classes/acltoken.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AclToken"},{"id":2,"kind":1024,"name":"name","url":"classes/acltoken.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AclToken"},{"id":3,"kind":1024,"name":"rules","url":"classes/acltoken.html#rules","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AclToken"},{"id":4,"kind":1024,"name":"type","url":"classes/acltoken.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AclToken"},{"id":5,"kind":128,"name":"BlockingQueryOptions","url":"classes/blockingqueryoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":1024,"name":"index","url":"classes/blockingqueryoptions.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":7,"kind":1024,"name":"wait","url":"classes/blockingqueryoptions.html#wait","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":8,"kind":128,"name":"Check","url":"classes/check.html","classes":"tsd-kind-class"},{"id":9,"kind":1024,"name":"id","url":"classes/check.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":10,"kind":1024,"name":"name","url":"classes/check.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":11,"kind":1024,"name":"nodeName","url":"classes/check.html#nodename","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":12,"kind":1024,"name":"notes","url":"classes/check.html#notes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":13,"kind":1024,"name":"output","url":"classes/check.html#output","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":14,"kind":1024,"name":"serviceId","url":"classes/check.html#serviceid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":15,"kind":1024,"name":"serviceName","url":"classes/check.html#servicename","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":16,"kind":1024,"name":"status","url":"classes/check.html#status","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Check"},{"id":17,"kind":128,"name":"CheckList","url":"classes/checklist.html","classes":"tsd-kind-class"},{"id":18,"kind":1024,"name":"index","url":"classes/checklist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckList"},{"id":19,"kind":1024,"name":"list","url":"classes/checklist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckList"},{"id":20,"kind":128,"name":"CheckOptions","url":"classes/checkoptions.html","classes":"tsd-kind-class"},{"id":21,"kind":1024,"name":"deregisterAfter","url":"classes/checkoptions.html#deregisterafter","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":22,"kind":1024,"name":"http","url":"classes/checkoptions.html#http","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":23,"kind":1024,"name":"id","url":"classes/checkoptions.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":24,"kind":1024,"name":"interval","url":"classes/checkoptions.html#interval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":25,"kind":1024,"name":"name","url":"classes/checkoptions.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":26,"kind":1024,"name":"notes","url":"classes/checkoptions.html#notes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":27,"kind":1024,"name":"script","url":"classes/checkoptions.html#script","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":28,"kind":1024,"name":"serviceId","url":"classes/checkoptions.html#serviceid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":29,"kind":1024,"name":"status","url":"classes/checkoptions.html#status","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":30,"kind":1024,"name":"tcp","url":"classes/checkoptions.html#tcp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":31,"kind":1024,"name":"ttl","url":"classes/checkoptions.html#ttl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckOptions"},{"id":32,"kind":128,"name":"CheckQueryOptions","url":"classes/checkqueryoptions.html","classes":"tsd-kind-class"},{"id":33,"kind":1024,"name":"blockingOptions","url":"classes/checkqueryoptions.html#blockingoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":34,"kind":1024,"name":"near","url":"classes/checkqueryoptions.html#near","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":35,"kind":128,"name":"ConsulClientOptions","url":"classes/consulclientoptions.html","classes":"tsd-kind-class"},{"id":36,"kind":1024,"name":"aclToken","url":"classes/consulclientoptions.html#acltoken","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":37,"kind":1024,"name":"alpnVersions","url":"classes/consulclientoptions.html#alpnversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":38,"kind":1024,"name":"connectTimeout","url":"classes/consulclientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":39,"kind":1024,"name":"crlPaths","url":"classes/consulclientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":40,"kind":1024,"name":"crlValues","url":"classes/consulclientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":41,"kind":1024,"name":"dc","url":"classes/consulclientoptions.html#dc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":42,"kind":1024,"name":"decoderInitialBufferSize","url":"classes/consulclientoptions.html#decoderinitialbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":43,"kind":1024,"name":"defaultHost","url":"classes/consulclientoptions.html#defaulthost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":44,"kind":1024,"name":"defaultPort","url":"classes/consulclientoptions.html#defaultport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":45,"kind":1024,"name":"enabledCipherSuites","url":"classes/consulclientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":46,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/consulclientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":47,"kind":1024,"name":"followRedirects","url":"classes/consulclientoptions.html#followredirects","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":48,"kind":1024,"name":"forceSni","url":"classes/consulclientoptions.html#forcesni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":49,"kind":1024,"name":"http2ClearTextUpgrade","url":"classes/consulclientoptions.html#http2cleartextupgrade","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":50,"kind":1024,"name":"http2ConnectionWindowSize","url":"classes/consulclientoptions.html#http2connectionwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":51,"kind":1024,"name":"http2KeepAliveTimeout","url":"classes/consulclientoptions.html#http2keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":52,"kind":1024,"name":"http2MaxPoolSize","url":"classes/consulclientoptions.html#http2maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":53,"kind":1024,"name":"http2MultiplexingLimit","url":"classes/consulclientoptions.html#http2multiplexinglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":54,"kind":1024,"name":"idleTimeout","url":"classes/consulclientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":55,"kind":1024,"name":"initialSettings","url":"classes/consulclientoptions.html#initialsettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":56,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/consulclientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":57,"kind":1024,"name":"keepAlive","url":"classes/consulclientoptions.html#keepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":58,"kind":1024,"name":"keepAliveTimeout","url":"classes/consulclientoptions.html#keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":59,"kind":1024,"name":"keyStoreOptions","url":"classes/consulclientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":60,"kind":1024,"name":"localAddress","url":"classes/consulclientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":61,"kind":1024,"name":"logActivity","url":"classes/consulclientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":62,"kind":1024,"name":"maxChunkSize","url":"classes/consulclientoptions.html#maxchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":63,"kind":1024,"name":"maxHeaderSize","url":"classes/consulclientoptions.html#maxheadersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":64,"kind":1024,"name":"maxInitialLineLength","url":"classes/consulclientoptions.html#maxinitiallinelength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":65,"kind":1024,"name":"maxPoolSize","url":"classes/consulclientoptions.html#maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":66,"kind":1024,"name":"maxRedirects","url":"classes/consulclientoptions.html#maxredirects","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":67,"kind":1024,"name":"maxWaitQueueSize","url":"classes/consulclientoptions.html#maxwaitqueuesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":68,"kind":1024,"name":"maxWebsocketFrameSize","url":"classes/consulclientoptions.html#maxwebsocketframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":69,"kind":1024,"name":"maxWebsocketMessageSize","url":"classes/consulclientoptions.html#maxwebsocketmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":70,"kind":1024,"name":"metricsName","url":"classes/consulclientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":71,"kind":1024,"name":"openSslEngineOptions","url":"classes/consulclientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":72,"kind":1024,"name":"pemKeyCertOptions","url":"classes/consulclientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":73,"kind":1024,"name":"pemTrustOptions","url":"classes/consulclientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":74,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/consulclientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":75,"kind":1024,"name":"pfxTrustOptions","url":"classes/consulclientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":76,"kind":1024,"name":"pipelining","url":"classes/consulclientoptions.html#pipelining","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":77,"kind":1024,"name":"pipeliningLimit","url":"classes/consulclientoptions.html#pipelininglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":78,"kind":1024,"name":"poolCleanerPeriod","url":"classes/consulclientoptions.html#poolcleanerperiod","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":79,"kind":1024,"name":"protocolVersion","url":"classes/consulclientoptions.html#protocolversion","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":80,"kind":1024,"name":"proxyOptions","url":"classes/consulclientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":81,"kind":1024,"name":"receiveBufferSize","url":"classes/consulclientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":82,"kind":1024,"name":"reuseAddress","url":"classes/consulclientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":83,"kind":1024,"name":"reusePort","url":"classes/consulclientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":84,"kind":1024,"name":"sendBufferSize","url":"classes/consulclientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":85,"kind":1024,"name":"sendUnmaskedFrames","url":"classes/consulclientoptions.html#sendunmaskedframes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":86,"kind":1024,"name":"soLinger","url":"classes/consulclientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":87,"kind":1024,"name":"ssl","url":"classes/consulclientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":88,"kind":1024,"name":"tcpCork","url":"classes/consulclientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":89,"kind":1024,"name":"tcpFastOpen","url":"classes/consulclientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":90,"kind":1024,"name":"tcpKeepAlive","url":"classes/consulclientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":91,"kind":1024,"name":"tcpNoDelay","url":"classes/consulclientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":92,"kind":1024,"name":"tcpQuickAck","url":"classes/consulclientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":93,"kind":1024,"name":"timeout","url":"classes/consulclientoptions.html#timeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":94,"kind":1024,"name":"trafficClass","url":"classes/consulclientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":95,"kind":1024,"name":"trustAll","url":"classes/consulclientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":96,"kind":1024,"name":"trustStoreOptions","url":"classes/consulclientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":97,"kind":1024,"name":"tryUseCompression","url":"classes/consulclientoptions.html#tryusecompression","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":98,"kind":1024,"name":"useAlpn","url":"classes/consulclientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":99,"kind":1024,"name":"usePooledBuffers","url":"classes/consulclientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":100,"kind":1024,"name":"userAgent","url":"classes/consulclientoptions.html#useragent","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":101,"kind":1024,"name":"userAgentEnabled","url":"classes/consulclientoptions.html#useragentenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":102,"kind":1024,"name":"verifyHost","url":"classes/consulclientoptions.html#verifyhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":103,"kind":128,"name":"Coordinate","url":"classes/coordinate.html","classes":"tsd-kind-class"},{"id":104,"kind":1024,"name":"adj","url":"classes/coordinate.html#adj","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Coordinate"},{"id":105,"kind":1024,"name":"err","url":"classes/coordinate.html#err","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Coordinate"},{"id":106,"kind":1024,"name":"height","url":"classes/coordinate.html#height","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Coordinate"},{"id":107,"kind":1024,"name":"node","url":"classes/coordinate.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Coordinate"},{"id":108,"kind":1024,"name":"vec","url":"classes/coordinate.html#vec","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Coordinate"},{"id":109,"kind":128,"name":"CoordinateList","url":"classes/coordinatelist.html","classes":"tsd-kind-class"},{"id":110,"kind":1024,"name":"index","url":"classes/coordinatelist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CoordinateList"},{"id":111,"kind":1024,"name":"list","url":"classes/coordinatelist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CoordinateList"},{"id":112,"kind":128,"name":"DcCoordinates","url":"classes/dccoordinates.html","classes":"tsd-kind-class"},{"id":113,"kind":1024,"name":"datacenter","url":"classes/dccoordinates.html#datacenter","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DcCoordinates"},{"id":114,"kind":1024,"name":"servers","url":"classes/dccoordinates.html#servers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DcCoordinates"},{"id":115,"kind":128,"name":"Event","url":"classes/event.html","classes":"tsd-kind-class"},{"id":116,"kind":1024,"name":"id","url":"classes/event.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":117,"kind":1024,"name":"lTime","url":"classes/event.html#ltime","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":118,"kind":1024,"name":"name","url":"classes/event.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":119,"kind":1024,"name":"node","url":"classes/event.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":120,"kind":1024,"name":"payload","url":"classes/event.html#payload","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":121,"kind":1024,"name":"service","url":"classes/event.html#service","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":122,"kind":1024,"name":"tag","url":"classes/event.html#tag","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":123,"kind":1024,"name":"version","url":"classes/event.html#version","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Event"},{"id":124,"kind":128,"name":"EventList","url":"classes/eventlist.html","classes":"tsd-kind-class"},{"id":125,"kind":1024,"name":"index","url":"classes/eventlist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventList"},{"id":126,"kind":1024,"name":"list","url":"classes/eventlist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventList"},{"id":127,"kind":128,"name":"EventListOptions","url":"classes/eventlistoptions.html","classes":"tsd-kind-class"},{"id":128,"kind":1024,"name":"blockingOptions","url":"classes/eventlistoptions.html#blockingoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventListOptions"},{"id":129,"kind":1024,"name":"name","url":"classes/eventlistoptions.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventListOptions"},{"id":130,"kind":128,"name":"EventOptions","url":"classes/eventoptions.html","classes":"tsd-kind-class"},{"id":131,"kind":1024,"name":"node","url":"classes/eventoptions.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventOptions"},{"id":132,"kind":1024,"name":"payload","url":"classes/eventoptions.html#payload","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventOptions"},{"id":133,"kind":1024,"name":"service","url":"classes/eventoptions.html#service","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventOptions"},{"id":134,"kind":1024,"name":"tag","url":"classes/eventoptions.html#tag","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventOptions"},{"id":135,"kind":128,"name":"KeyValue","url":"classes/keyvalue.html","classes":"tsd-kind-class"},{"id":136,"kind":1024,"name":"createIndex","url":"classes/keyvalue.html#createindex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":137,"kind":1024,"name":"flags","url":"classes/keyvalue.html#flags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":138,"kind":1024,"name":"key","url":"classes/keyvalue.html#key","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":139,"kind":1024,"name":"lockIndex","url":"classes/keyvalue.html#lockindex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":140,"kind":1024,"name":"modifyIndex","url":"classes/keyvalue.html#modifyindex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":141,"kind":1024,"name":"session","url":"classes/keyvalue.html#session","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":142,"kind":1024,"name":"value","url":"classes/keyvalue.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValue"},{"id":143,"kind":128,"name":"KeyValueList","url":"classes/keyvaluelist.html","classes":"tsd-kind-class"},{"id":144,"kind":1024,"name":"index","url":"classes/keyvaluelist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValueList"},{"id":145,"kind":1024,"name":"list","url":"classes/keyvaluelist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValueList"},{"id":146,"kind":128,"name":"KeyValueOptions","url":"classes/keyvalueoptions.html","classes":"tsd-kind-class"},{"id":147,"kind":1024,"name":"acquireSession","url":"classes/keyvalueoptions.html#acquiresession","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":148,"kind":1024,"name":"casIndex","url":"classes/keyvalueoptions.html#casindex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":149,"kind":1024,"name":"flags","url":"classes/keyvalueoptions.html#flags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":150,"kind":1024,"name":"releaseSession","url":"classes/keyvalueoptions.html#releasesession","classes":"tsd-kind-property tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":151,"kind":128,"name":"MaintenanceOptions","url":"classes/maintenanceoptions.html","classes":"tsd-kind-class"},{"id":152,"kind":1024,"name":"enable","url":"classes/maintenanceoptions.html#enable","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":153,"kind":1024,"name":"id","url":"classes/maintenanceoptions.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":154,"kind":1024,"name":"reason","url":"classes/maintenanceoptions.html#reason","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":155,"kind":128,"name":"Node","url":"classes/node.html","classes":"tsd-kind-class"},{"id":156,"kind":1024,"name":"address","url":"classes/node.html#address","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":157,"kind":1024,"name":"lanAddress","url":"classes/node.html#lanaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":158,"kind":1024,"name":"name","url":"classes/node.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":159,"kind":1024,"name":"wanAddress","url":"classes/node.html#wanaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":160,"kind":128,"name":"NodeList","url":"classes/nodelist.html","classes":"tsd-kind-class"},{"id":161,"kind":1024,"name":"index","url":"classes/nodelist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NodeList"},{"id":162,"kind":1024,"name":"list","url":"classes/nodelist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NodeList"},{"id":163,"kind":128,"name":"NodeQueryOptions","url":"classes/nodequeryoptions.html","classes":"tsd-kind-class"},{"id":164,"kind":1024,"name":"blockingOptions","url":"classes/nodequeryoptions.html#blockingoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":165,"kind":1024,"name":"near","url":"classes/nodequeryoptions.html#near","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":166,"kind":128,"name":"PreparedQueryDefinition","url":"classes/preparedquerydefinition.html","classes":"tsd-kind-class"},{"id":167,"kind":1024,"name":"dcs","url":"classes/preparedquerydefinition.html#dcs","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":168,"kind":1024,"name":"dnsTtl","url":"classes/preparedquerydefinition.html#dnsttl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":169,"kind":1024,"name":"id","url":"classes/preparedquerydefinition.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":170,"kind":1024,"name":"meta","url":"classes/preparedquerydefinition.html#meta","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":171,"kind":1024,"name":"name","url":"classes/preparedquerydefinition.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":172,"kind":1024,"name":"nearestN","url":"classes/preparedquerydefinition.html#nearestn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":173,"kind":1024,"name":"passing","url":"classes/preparedquerydefinition.html#passing","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":174,"kind":1024,"name":"service","url":"classes/preparedquerydefinition.html#service","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":175,"kind":1024,"name":"session","url":"classes/preparedquerydefinition.html#session","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":176,"kind":1024,"name":"tags","url":"classes/preparedquerydefinition.html#tags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":177,"kind":1024,"name":"templateRegexp","url":"classes/preparedquerydefinition.html#templateregexp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":178,"kind":1024,"name":"templateType","url":"classes/preparedquerydefinition.html#templatetype","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":179,"kind":1024,"name":"token","url":"classes/preparedquerydefinition.html#token","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":180,"kind":128,"name":"PreparedQueryExecuteOptions","url":"classes/preparedqueryexecuteoptions.html","classes":"tsd-kind-class"},{"id":181,"kind":1024,"name":"limit","url":"classes/preparedqueryexecuteoptions.html#limit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":182,"kind":1024,"name":"near","url":"classes/preparedqueryexecuteoptions.html#near","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":183,"kind":128,"name":"PreparedQueryExecuteResponse","url":"classes/preparedqueryexecuteresponse.html","classes":"tsd-kind-class"},{"id":184,"kind":1024,"name":"dc","url":"classes/preparedqueryexecuteresponse.html#dc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":185,"kind":1024,"name":"dnsTtl","url":"classes/preparedqueryexecuteresponse.html#dnsttl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":186,"kind":1024,"name":"failovers","url":"classes/preparedqueryexecuteresponse.html#failovers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":187,"kind":1024,"name":"nodes","url":"classes/preparedqueryexecuteresponse.html#nodes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":188,"kind":1024,"name":"service","url":"classes/preparedqueryexecuteresponse.html#service","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":189,"kind":128,"name":"Service","url":"classes/service.html","classes":"tsd-kind-class"},{"id":190,"kind":1024,"name":"address","url":"classes/service.html#address","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":191,"kind":1024,"name":"id","url":"classes/service.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":192,"kind":1024,"name":"name","url":"classes/service.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":193,"kind":1024,"name":"node","url":"classes/service.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":194,"kind":1024,"name":"nodeAddress","url":"classes/service.html#nodeaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":195,"kind":1024,"name":"port","url":"classes/service.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":196,"kind":1024,"name":"tags","url":"classes/service.html#tags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Service"},{"id":197,"kind":128,"name":"ServiceEntry","url":"classes/serviceentry.html","classes":"tsd-kind-class"},{"id":198,"kind":1024,"name":"checks","url":"classes/serviceentry.html#checks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceEntry"},{"id":199,"kind":1024,"name":"node","url":"classes/serviceentry.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceEntry"},{"id":200,"kind":1024,"name":"service","url":"classes/serviceentry.html#service","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceEntry"},{"id":201,"kind":128,"name":"ServiceEntryList","url":"classes/serviceentrylist.html","classes":"tsd-kind-class"},{"id":202,"kind":1024,"name":"index","url":"classes/serviceentrylist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":203,"kind":1024,"name":"list","url":"classes/serviceentrylist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":204,"kind":128,"name":"ServiceList","url":"classes/servicelist.html","classes":"tsd-kind-class"},{"id":205,"kind":1024,"name":"index","url":"classes/servicelist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceList"},{"id":206,"kind":1024,"name":"list","url":"classes/servicelist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceList"},{"id":207,"kind":128,"name":"ServiceOptions","url":"classes/serviceoptions.html","classes":"tsd-kind-class"},{"id":208,"kind":1024,"name":"address","url":"classes/serviceoptions.html#address","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceOptions"},{"id":209,"kind":1024,"name":"checkOptions","url":"classes/serviceoptions.html#checkoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceOptions"},{"id":210,"kind":1024,"name":"id","url":"classes/serviceoptions.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceOptions"},{"id":211,"kind":1024,"name":"name","url":"classes/serviceoptions.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceOptions"},{"id":212,"kind":1024,"name":"port","url":"classes/serviceoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceOptions"},{"id":213,"kind":1024,"name":"tags","url":"classes/serviceoptions.html#tags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceOptions"},{"id":214,"kind":128,"name":"ServiceQueryOptions","url":"classes/servicequeryoptions.html","classes":"tsd-kind-class"},{"id":215,"kind":1024,"name":"blockingOptions","url":"classes/servicequeryoptions.html#blockingoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":216,"kind":1024,"name":"near","url":"classes/servicequeryoptions.html#near","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":217,"kind":1024,"name":"tag","url":"classes/servicequeryoptions.html#tag","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":218,"kind":128,"name":"Session","url":"classes/session.html","classes":"tsd-kind-class"},{"id":219,"kind":1024,"name":"checks","url":"classes/session.html#checks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":220,"kind":1024,"name":"createIndex","url":"classes/session.html#createindex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":221,"kind":1024,"name":"id","url":"classes/session.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":222,"kind":1024,"name":"index","url":"classes/session.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":223,"kind":1024,"name":"lockDelay","url":"classes/session.html#lockdelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":224,"kind":1024,"name":"node","url":"classes/session.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":225,"kind":128,"name":"SessionList","url":"classes/sessionlist.html","classes":"tsd-kind-class"},{"id":226,"kind":1024,"name":"index","url":"classes/sessionlist.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionList"},{"id":227,"kind":1024,"name":"list","url":"classes/sessionlist.html#list","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionList"},{"id":228,"kind":128,"name":"SessionOptions","url":"classes/sessionoptions.html","classes":"tsd-kind-class"},{"id":229,"kind":1024,"name":"behavior","url":"classes/sessionoptions.html#behavior","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionOptions"},{"id":230,"kind":1024,"name":"checks","url":"classes/sessionoptions.html#checks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionOptions"},{"id":231,"kind":1024,"name":"lockDelay","url":"classes/sessionoptions.html#lockdelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionOptions"},{"id":232,"kind":1024,"name":"name","url":"classes/sessionoptions.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionOptions"},{"id":233,"kind":1024,"name":"node","url":"classes/sessionoptions.html#node","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionOptions"},{"id":234,"kind":1024,"name":"ttl","url":"classes/sessionoptions.html#ttl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SessionOptions"},{"id":235,"kind":128,"name":"TxnError","url":"classes/txnerror.html","classes":"tsd-kind-class"},{"id":236,"kind":1024,"name":"opIndex","url":"classes/txnerror.html#opindex","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnError"},{"id":237,"kind":1024,"name":"what","url":"classes/txnerror.html#what","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnError"},{"id":238,"kind":128,"name":"TxnKVOperation","url":"classes/txnkvoperation.html","classes":"tsd-kind-class"},{"id":239,"kind":1024,"name":"flags","url":"classes/txnkvoperation.html#flags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":240,"kind":1024,"name":"index","url":"classes/txnkvoperation.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":241,"kind":1024,"name":"key","url":"classes/txnkvoperation.html#key","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":242,"kind":1024,"name":"session","url":"classes/txnkvoperation.html#session","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":243,"kind":1024,"name":"type","url":"classes/txnkvoperation.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":244,"kind":1024,"name":"value","url":"classes/txnkvoperation.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":245,"kind":128,"name":"TxnRequest","url":"classes/txnrequest.html","classes":"tsd-kind-class"},{"id":246,"kind":128,"name":"TxnResponse","url":"classes/txnresponse.html","classes":"tsd-kind-class"},{"id":247,"kind":1024,"name":"errors","url":"classes/txnresponse.html#errors","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TxnResponse"},{"id":248,"kind":128,"name":"ConsulClient","url":"classes/consulclient.html","classes":"tsd-kind-class"},{"id":249,"kind":2048,"name":"create","url":"classes/consulclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ConsulClient"},{"id":250,"kind":2048,"name":"agentInfo","url":"classes/consulclient.html#agentinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":251,"kind":2048,"name":"coordinateNodes","url":"classes/consulclient.html#coordinatenodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":252,"kind":2048,"name":"coordinateNodesWithOptions","url":"classes/consulclient.html#coordinatenodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":253,"kind":2048,"name":"coordinateDatacenters","url":"classes/consulclient.html#coordinatedatacenters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":254,"kind":2048,"name":"getKeys","url":"classes/consulclient.html#getkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":255,"kind":2048,"name":"getKeysWithOptions","url":"classes/consulclient.html#getkeyswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":256,"kind":2048,"name":"getValue","url":"classes/consulclient.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":257,"kind":2048,"name":"getValueWithOptions","url":"classes/consulclient.html#getvaluewithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":258,"kind":2048,"name":"deleteValue","url":"classes/consulclient.html#deletevalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":259,"kind":2048,"name":"getValues","url":"classes/consulclient.html#getvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":260,"kind":2048,"name":"getValuesWithOptions","url":"classes/consulclient.html#getvalueswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":261,"kind":2048,"name":"deleteValues","url":"classes/consulclient.html#deletevalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":262,"kind":2048,"name":"putValue","url":"classes/consulclient.html#putvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":263,"kind":2048,"name":"putValueWithOptions","url":"classes/consulclient.html#putvaluewithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":264,"kind":2048,"name":"transaction","url":"classes/consulclient.html#transaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":265,"kind":2048,"name":"createAclToken","url":"classes/consulclient.html#createacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":266,"kind":2048,"name":"updateAclToken","url":"classes/consulclient.html#updateacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":267,"kind":2048,"name":"cloneAclToken","url":"classes/consulclient.html#cloneacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":268,"kind":2048,"name":"listAclTokens","url":"classes/consulclient.html#listacltokens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":269,"kind":2048,"name":"infoAclToken","url":"classes/consulclient.html#infoacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":270,"kind":2048,"name":"destroyAclToken","url":"classes/consulclient.html#destroyacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":271,"kind":2048,"name":"fireEvent","url":"classes/consulclient.html#fireevent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":272,"kind":2048,"name":"fireEventWithOptions","url":"classes/consulclient.html#fireeventwithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":273,"kind":2048,"name":"listEvents","url":"classes/consulclient.html#listevents","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":274,"kind":2048,"name":"listEventsWithOptions","url":"classes/consulclient.html#listeventswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":275,"kind":2048,"name":"registerService","url":"classes/consulclient.html#registerservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":276,"kind":2048,"name":"maintenanceService","url":"classes/consulclient.html#maintenanceservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":277,"kind":2048,"name":"deregisterService","url":"classes/consulclient.html#deregisterservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":278,"kind":2048,"name":"catalogServiceNodes","url":"classes/consulclient.html#catalogservicenodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":279,"kind":2048,"name":"catalogServiceNodesWithOptions","url":"classes/consulclient.html#catalogservicenodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":280,"kind":2048,"name":"catalogDatacenters","url":"classes/consulclient.html#catalogdatacenters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":281,"kind":2048,"name":"catalogNodes","url":"classes/consulclient.html#catalognodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":282,"kind":2048,"name":"catalogNodesWithOptions","url":"classes/consulclient.html#catalognodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":283,"kind":2048,"name":"healthChecks","url":"classes/consulclient.html#healthchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":284,"kind":2048,"name":"healthChecksWithOptions","url":"classes/consulclient.html#healthcheckswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":285,"kind":2048,"name":"healthState","url":"classes/consulclient.html#healthstate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":286,"kind":2048,"name":"healthStateWithOptions","url":"classes/consulclient.html#healthstatewithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":287,"kind":2048,"name":"healthServiceNodes","url":"classes/consulclient.html#healthservicenodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":288,"kind":2048,"name":"healthServiceNodesWithOptions","url":"classes/consulclient.html#healthservicenodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":289,"kind":2048,"name":"catalogServices","url":"classes/consulclient.html#catalogservices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":290,"kind":2048,"name":"catalogServicesWithOptions","url":"classes/consulclient.html#catalogserviceswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":291,"kind":2048,"name":"catalogNodeServices","url":"classes/consulclient.html#catalognodeservices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":292,"kind":2048,"name":"catalogNodeServicesWithOptions","url":"classes/consulclient.html#catalognodeserviceswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":293,"kind":2048,"name":"localServices","url":"classes/consulclient.html#localservices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":294,"kind":2048,"name":"localChecks","url":"classes/consulclient.html#localchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":295,"kind":2048,"name":"registerCheck","url":"classes/consulclient.html#registercheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":296,"kind":2048,"name":"deregisterCheck","url":"classes/consulclient.html#deregistercheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":297,"kind":2048,"name":"passCheck","url":"classes/consulclient.html#passcheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":298,"kind":2048,"name":"passCheckWithNote","url":"classes/consulclient.html#passcheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":299,"kind":2048,"name":"warnCheck","url":"classes/consulclient.html#warncheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":300,"kind":2048,"name":"warnCheckWithNote","url":"classes/consulclient.html#warncheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":301,"kind":2048,"name":"failCheck","url":"classes/consulclient.html#failcheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":302,"kind":2048,"name":"failCheckWithNote","url":"classes/consulclient.html#failcheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":303,"kind":2048,"name":"updateCheck","url":"classes/consulclient.html#updatecheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":304,"kind":2048,"name":"updateCheckWithNote","url":"classes/consulclient.html#updatecheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":305,"kind":2048,"name":"leaderStatus","url":"classes/consulclient.html#leaderstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":306,"kind":2048,"name":"peersStatus","url":"classes/consulclient.html#peersstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":307,"kind":2048,"name":"createSession","url":"classes/consulclient.html#createsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":308,"kind":2048,"name":"createSessionWithOptions","url":"classes/consulclient.html#createsessionwithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":309,"kind":2048,"name":"infoSession","url":"classes/consulclient.html#infosession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":310,"kind":2048,"name":"infoSessionWithOptions","url":"classes/consulclient.html#infosessionwithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":311,"kind":2048,"name":"renewSession","url":"classes/consulclient.html#renewsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":312,"kind":2048,"name":"listSessions","url":"classes/consulclient.html#listsessions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":313,"kind":2048,"name":"listSessionsWithOptions","url":"classes/consulclient.html#listsessionswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":314,"kind":2048,"name":"listNodeSessions","url":"classes/consulclient.html#listnodesessions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":315,"kind":2048,"name":"listNodeSessionsWithOptions","url":"classes/consulclient.html#listnodesessionswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":316,"kind":2048,"name":"destroySession","url":"classes/consulclient.html#destroysession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":317,"kind":2048,"name":"createPreparedQuery","url":"classes/consulclient.html#createpreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":318,"kind":2048,"name":"getPreparedQuery","url":"classes/consulclient.html#getpreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":319,"kind":2048,"name":"getAllPreparedQueries","url":"classes/consulclient.html#getallpreparedqueries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":320,"kind":2048,"name":"updatePreparedQuery","url":"classes/consulclient.html#updatepreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":321,"kind":2048,"name":"deletePreparedQuery","url":"classes/consulclient.html#deletepreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":322,"kind":2048,"name":"executePreparedQuery","url":"classes/consulclient.html#executepreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":323,"kind":2048,"name":"executePreparedQueryWithOptions","url":"classes/consulclient.html#executepreparedquerywithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":324,"kind":2048,"name":"close","url":"classes/consulclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":325,"kind":128,"name":"Watch","url":"classes/watch.html","classes":"tsd-kind-class"},{"id":326,"kind":2048,"name":"key","url":"classes/watch.html#key","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":327,"kind":2048,"name":"keyPrefix","url":"classes/watch.html#keyprefix","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":328,"kind":2048,"name":"services","url":"classes/watch.html#services","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":329,"kind":2048,"name":"service","url":"classes/watch.html#service","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":330,"kind":2048,"name":"events","url":"classes/watch.html#events","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":331,"kind":2048,"name":"nodes","url":"classes/watch.html#nodes","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":332,"kind":2048,"name":"setHandler","url":"classes/watch.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Watch"},{"id":333,"kind":2048,"name":"start","url":"classes/watch.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Watch"},{"id":334,"kind":2048,"name":"stop","url":"classes/watch.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Watch"},{"id":335,"kind":128,"name":"WatchResult","url":"classes/watchresult.html","classes":"tsd-kind-class"},{"id":336,"kind":2048,"name":"prevResult","url":"classes/watchresult.html#prevresult","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":337,"kind":2048,"name":"nextResult","url":"classes/watchresult.html#nextresult","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":338,"kind":2048,"name":"cause","url":"classes/watchresult.html#cause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":339,"kind":2048,"name":"succeeded","url":"classes/watchresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":340,"kind":2048,"name":"failed","url":"classes/watchresult.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"AclToken","url":"classes/acltoken.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/acltoken.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"AclToken"},{"id":2,"kind":2048,"name":"getId","url":"classes/acltoken.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":3,"kind":2048,"name":"setId","url":"classes/acltoken.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":4,"kind":2048,"name":"getName","url":"classes/acltoken.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":5,"kind":2048,"name":"setName","url":"classes/acltoken.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":6,"kind":2048,"name":"getRules","url":"classes/acltoken.html#getrules","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":7,"kind":2048,"name":"setRules","url":"classes/acltoken.html#setrules","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":8,"kind":2048,"name":"getType","url":"classes/acltoken.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":9,"kind":2048,"name":"setType","url":"classes/acltoken.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AclToken"},{"id":10,"kind":128,"name":"BlockingQueryOptions","url":"classes/blockingqueryoptions.html","classes":"tsd-kind-class"},{"id":11,"kind":512,"name":"constructor","url":"classes/blockingqueryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":12,"kind":2048,"name":"getIndex","url":"classes/blockingqueryoptions.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":13,"kind":2048,"name":"setIndex","url":"classes/blockingqueryoptions.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":14,"kind":2048,"name":"getWait","url":"classes/blockingqueryoptions.html#getwait","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":15,"kind":2048,"name":"setWait","url":"classes/blockingqueryoptions.html#setwait","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BlockingQueryOptions"},{"id":16,"kind":128,"name":"Check","url":"classes/check.html","classes":"tsd-kind-class"},{"id":17,"kind":512,"name":"constructor","url":"classes/check.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Check"},{"id":18,"kind":2048,"name":"getId","url":"classes/check.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":19,"kind":2048,"name":"setId","url":"classes/check.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":20,"kind":2048,"name":"getName","url":"classes/check.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":21,"kind":2048,"name":"setName","url":"classes/check.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":22,"kind":2048,"name":"getNodeName","url":"classes/check.html#getnodename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":23,"kind":2048,"name":"setNodeName","url":"classes/check.html#setnodename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":24,"kind":2048,"name":"getNotes","url":"classes/check.html#getnotes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":25,"kind":2048,"name":"setNotes","url":"classes/check.html#setnotes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":26,"kind":2048,"name":"getOutput","url":"classes/check.html#getoutput","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":27,"kind":2048,"name":"setOutput","url":"classes/check.html#setoutput","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":28,"kind":2048,"name":"getServiceId","url":"classes/check.html#getserviceid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":29,"kind":2048,"name":"setServiceId","url":"classes/check.html#setserviceid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":30,"kind":2048,"name":"getServiceName","url":"classes/check.html#getservicename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":31,"kind":2048,"name":"setServiceName","url":"classes/check.html#setservicename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":32,"kind":2048,"name":"getStatus","url":"classes/check.html#getstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":33,"kind":2048,"name":"setStatus","url":"classes/check.html#setstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Check"},{"id":34,"kind":128,"name":"CheckList","url":"classes/checklist.html","classes":"tsd-kind-class"},{"id":35,"kind":512,"name":"constructor","url":"classes/checklist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CheckList"},{"id":36,"kind":2048,"name":"getIndex","url":"classes/checklist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckList"},{"id":37,"kind":2048,"name":"setIndex","url":"classes/checklist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckList"},{"id":38,"kind":2048,"name":"getList","url":"classes/checklist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckList"},{"id":39,"kind":2048,"name":"setList","url":"classes/checklist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckList"},{"id":40,"kind":128,"name":"CheckOptions","url":"classes/checkoptions.html","classes":"tsd-kind-class"},{"id":41,"kind":512,"name":"constructor","url":"classes/checkoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CheckOptions"},{"id":42,"kind":2048,"name":"getDeregisterAfter","url":"classes/checkoptions.html#getderegisterafter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":43,"kind":2048,"name":"setDeregisterAfter","url":"classes/checkoptions.html#setderegisterafter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":44,"kind":2048,"name":"getGrpc","url":"classes/checkoptions.html#getgrpc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":45,"kind":2048,"name":"setGrpc","url":"classes/checkoptions.html#setgrpc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":46,"kind":2048,"name":"isGrpcTls","url":"classes/checkoptions.html#isgrpctls","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":47,"kind":2048,"name":"setGrpcTls","url":"classes/checkoptions.html#setgrpctls","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":48,"kind":2048,"name":"getHttp","url":"classes/checkoptions.html#gethttp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":49,"kind":2048,"name":"setHttp","url":"classes/checkoptions.html#sethttp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":50,"kind":2048,"name":"getId","url":"classes/checkoptions.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":51,"kind":2048,"name":"setId","url":"classes/checkoptions.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":52,"kind":2048,"name":"getInterval","url":"classes/checkoptions.html#getinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":53,"kind":2048,"name":"setInterval","url":"classes/checkoptions.html#setinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":54,"kind":2048,"name":"getName","url":"classes/checkoptions.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":55,"kind":2048,"name":"setName","url":"classes/checkoptions.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":56,"kind":2048,"name":"getNotes","url":"classes/checkoptions.html#getnotes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":57,"kind":2048,"name":"setNotes","url":"classes/checkoptions.html#setnotes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":58,"kind":2048,"name":"getScriptArgs","url":"classes/checkoptions.html#getscriptargs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":59,"kind":2048,"name":"setScriptArgs","url":"classes/checkoptions.html#setscriptargs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":60,"kind":2048,"name":"getServiceId","url":"classes/checkoptions.html#getserviceid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":61,"kind":2048,"name":"setServiceId","url":"classes/checkoptions.html#setserviceid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":62,"kind":2048,"name":"getStatus","url":"classes/checkoptions.html#getstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":63,"kind":2048,"name":"setStatus","url":"classes/checkoptions.html#setstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":64,"kind":2048,"name":"getTcp","url":"classes/checkoptions.html#gettcp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":65,"kind":2048,"name":"setTcp","url":"classes/checkoptions.html#settcp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":66,"kind":2048,"name":"isTlsSkipVerify","url":"classes/checkoptions.html#istlsskipverify","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":67,"kind":2048,"name":"setTlsSkipVerify","url":"classes/checkoptions.html#settlsskipverify","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":68,"kind":2048,"name":"getTtl","url":"classes/checkoptions.html#getttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":69,"kind":2048,"name":"setTtl","url":"classes/checkoptions.html#setttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckOptions"},{"id":70,"kind":128,"name":"CheckQueryOptions","url":"classes/checkqueryoptions.html","classes":"tsd-kind-class"},{"id":71,"kind":512,"name":"constructor","url":"classes/checkqueryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":72,"kind":2048,"name":"getBlockingOptions","url":"classes/checkqueryoptions.html#getblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":73,"kind":2048,"name":"setBlockingOptions","url":"classes/checkqueryoptions.html#setblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":74,"kind":2048,"name":"getNear","url":"classes/checkqueryoptions.html#getnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":75,"kind":2048,"name":"setNear","url":"classes/checkqueryoptions.html#setnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CheckQueryOptions"},{"id":76,"kind":128,"name":"ConsulClientOptions","url":"classes/consulclientoptions.html","classes":"tsd-kind-class"},{"id":77,"kind":512,"name":"constructor","url":"classes/consulclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":78,"kind":2048,"name":"getAclToken","url":"classes/consulclientoptions.html#getacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":79,"kind":2048,"name":"setAclToken","url":"classes/consulclientoptions.html#setacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":80,"kind":2048,"name":"getAlpnVersions","url":"classes/consulclientoptions.html#getalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":81,"kind":2048,"name":"setAlpnVersions","url":"classes/consulclientoptions.html#setalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":82,"kind":2048,"name":"getConnectTimeout","url":"classes/consulclientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":83,"kind":2048,"name":"setConnectTimeout","url":"classes/consulclientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":84,"kind":2048,"name":"getCrlPaths","url":"classes/consulclientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":85,"kind":2048,"name":"addCrlPath","url":"classes/consulclientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":86,"kind":2048,"name":"getCrlValues","url":"classes/consulclientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":87,"kind":2048,"name":"addCrlValue","url":"classes/consulclientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":88,"kind":2048,"name":"getDc","url":"classes/consulclientoptions.html#getdc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":89,"kind":2048,"name":"setDc","url":"classes/consulclientoptions.html#setdc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":90,"kind":2048,"name":"getDecoderInitialBufferSize","url":"classes/consulclientoptions.html#getdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":91,"kind":2048,"name":"setDecoderInitialBufferSize","url":"classes/consulclientoptions.html#setdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":92,"kind":2048,"name":"getDefaultHost","url":"classes/consulclientoptions.html#getdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":93,"kind":2048,"name":"setDefaultHost","url":"classes/consulclientoptions.html#setdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":94,"kind":2048,"name":"getDefaultPort","url":"classes/consulclientoptions.html#getdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":95,"kind":2048,"name":"setDefaultPort","url":"classes/consulclientoptions.html#setdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":96,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/consulclientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":97,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/consulclientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":98,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/consulclientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":99,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/consulclientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":100,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/consulclientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":101,"kind":2048,"name":"isFollowRedirects","url":"classes/consulclientoptions.html#isfollowredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":102,"kind":2048,"name":"setFollowRedirects","url":"classes/consulclientoptions.html#setfollowredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":103,"kind":2048,"name":"isForceSni","url":"classes/consulclientoptions.html#isforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":104,"kind":2048,"name":"setForceSni","url":"classes/consulclientoptions.html#setforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":105,"kind":2048,"name":"isHttp2ClearTextUpgrade","url":"classes/consulclientoptions.html#ishttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":106,"kind":2048,"name":"setHttp2ClearTextUpgrade","url":"classes/consulclientoptions.html#sethttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":107,"kind":2048,"name":"getHttp2ConnectionWindowSize","url":"classes/consulclientoptions.html#gethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":108,"kind":2048,"name":"setHttp2ConnectionWindowSize","url":"classes/consulclientoptions.html#sethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":109,"kind":2048,"name":"getHttp2KeepAliveTimeout","url":"classes/consulclientoptions.html#gethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":110,"kind":2048,"name":"setHttp2KeepAliveTimeout","url":"classes/consulclientoptions.html#sethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":111,"kind":2048,"name":"getHttp2MaxPoolSize","url":"classes/consulclientoptions.html#gethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":112,"kind":2048,"name":"setHttp2MaxPoolSize","url":"classes/consulclientoptions.html#sethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":113,"kind":2048,"name":"getHttp2MultiplexingLimit","url":"classes/consulclientoptions.html#gethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":114,"kind":2048,"name":"setHttp2MultiplexingLimit","url":"classes/consulclientoptions.html#sethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":115,"kind":2048,"name":"getIdleTimeout","url":"classes/consulclientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":116,"kind":2048,"name":"setIdleTimeout","url":"classes/consulclientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":117,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/consulclientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":118,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/consulclientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":119,"kind":2048,"name":"getInitialSettings","url":"classes/consulclientoptions.html#getinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":120,"kind":2048,"name":"setInitialSettings","url":"classes/consulclientoptions.html#setinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":121,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/consulclientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":122,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/consulclientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":123,"kind":2048,"name":"isKeepAlive","url":"classes/consulclientoptions.html#iskeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":124,"kind":2048,"name":"setKeepAlive","url":"classes/consulclientoptions.html#setkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":125,"kind":2048,"name":"getKeepAliveTimeout","url":"classes/consulclientoptions.html#getkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":126,"kind":2048,"name":"setKeepAliveTimeout","url":"classes/consulclientoptions.html#setkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":127,"kind":2048,"name":"getKeyStoreOptions","url":"classes/consulclientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":128,"kind":2048,"name":"setKeyStoreOptions","url":"classes/consulclientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":129,"kind":2048,"name":"getLocalAddress","url":"classes/consulclientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":130,"kind":2048,"name":"setLocalAddress","url":"classes/consulclientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":131,"kind":2048,"name":"getLogActivity","url":"classes/consulclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":132,"kind":2048,"name":"setLogActivity","url":"classes/consulclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":133,"kind":2048,"name":"getMaxChunkSize","url":"classes/consulclientoptions.html#getmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":134,"kind":2048,"name":"setMaxChunkSize","url":"classes/consulclientoptions.html#setmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":135,"kind":2048,"name":"getMaxHeaderSize","url":"classes/consulclientoptions.html#getmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":136,"kind":2048,"name":"setMaxHeaderSize","url":"classes/consulclientoptions.html#setmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":137,"kind":2048,"name":"getMaxInitialLineLength","url":"classes/consulclientoptions.html#getmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":138,"kind":2048,"name":"setMaxInitialLineLength","url":"classes/consulclientoptions.html#setmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":139,"kind":2048,"name":"getMaxPoolSize","url":"classes/consulclientoptions.html#getmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":140,"kind":2048,"name":"setMaxPoolSize","url":"classes/consulclientoptions.html#setmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":141,"kind":2048,"name":"getMaxRedirects","url":"classes/consulclientoptions.html#getmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":142,"kind":2048,"name":"setMaxRedirects","url":"classes/consulclientoptions.html#setmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":143,"kind":2048,"name":"getMaxWaitQueueSize","url":"classes/consulclientoptions.html#getmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":144,"kind":2048,"name":"setMaxWaitQueueSize","url":"classes/consulclientoptions.html#setmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":145,"kind":2048,"name":"getMaxWebsocketFrameSize","url":"classes/consulclientoptions.html#getmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":146,"kind":2048,"name":"setMaxWebsocketFrameSize","url":"classes/consulclientoptions.html#setmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":147,"kind":2048,"name":"getMaxWebsocketMessageSize","url":"classes/consulclientoptions.html#getmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":148,"kind":2048,"name":"setMaxWebsocketMessageSize","url":"classes/consulclientoptions.html#setmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":149,"kind":2048,"name":"getMetricsName","url":"classes/consulclientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":150,"kind":2048,"name":"setMetricsName","url":"classes/consulclientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":151,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/consulclientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":152,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/consulclientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":153,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/consulclientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":154,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/consulclientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":155,"kind":2048,"name":"getPemTrustOptions","url":"classes/consulclientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":156,"kind":2048,"name":"setPemTrustOptions","url":"classes/consulclientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":157,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/consulclientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":158,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/consulclientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":159,"kind":2048,"name":"getPfxTrustOptions","url":"classes/consulclientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":160,"kind":2048,"name":"setPfxTrustOptions","url":"classes/consulclientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":161,"kind":2048,"name":"isPipelining","url":"classes/consulclientoptions.html#ispipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":162,"kind":2048,"name":"setPipelining","url":"classes/consulclientoptions.html#setpipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":163,"kind":2048,"name":"getPipeliningLimit","url":"classes/consulclientoptions.html#getpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":164,"kind":2048,"name":"setPipeliningLimit","url":"classes/consulclientoptions.html#setpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":165,"kind":2048,"name":"getPoolCleanerPeriod","url":"classes/consulclientoptions.html#getpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":166,"kind":2048,"name":"setPoolCleanerPeriod","url":"classes/consulclientoptions.html#setpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":167,"kind":2048,"name":"getProtocolVersion","url":"classes/consulclientoptions.html#getprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":168,"kind":2048,"name":"setProtocolVersion","url":"classes/consulclientoptions.html#setprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":169,"kind":2048,"name":"getProxyOptions","url":"classes/consulclientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":170,"kind":2048,"name":"setProxyOptions","url":"classes/consulclientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":171,"kind":2048,"name":"getReceiveBufferSize","url":"classes/consulclientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":172,"kind":2048,"name":"setReceiveBufferSize","url":"classes/consulclientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":173,"kind":2048,"name":"isReuseAddress","url":"classes/consulclientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":174,"kind":2048,"name":"setReuseAddress","url":"classes/consulclientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":175,"kind":2048,"name":"isReusePort","url":"classes/consulclientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":176,"kind":2048,"name":"setReusePort","url":"classes/consulclientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":177,"kind":2048,"name":"getSendBufferSize","url":"classes/consulclientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":178,"kind":2048,"name":"setSendBufferSize","url":"classes/consulclientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":179,"kind":2048,"name":"isSendUnmaskedFrames","url":"classes/consulclientoptions.html#issendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":180,"kind":2048,"name":"setSendUnmaskedFrames","url":"classes/consulclientoptions.html#setsendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":181,"kind":2048,"name":"getSoLinger","url":"classes/consulclientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":182,"kind":2048,"name":"setSoLinger","url":"classes/consulclientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":183,"kind":2048,"name":"isSsl","url":"classes/consulclientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":184,"kind":2048,"name":"setSsl","url":"classes/consulclientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":185,"kind":2048,"name":"isTcpCork","url":"classes/consulclientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":186,"kind":2048,"name":"setTcpCork","url":"classes/consulclientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":187,"kind":2048,"name":"isTcpFastOpen","url":"classes/consulclientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":188,"kind":2048,"name":"setTcpFastOpen","url":"classes/consulclientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":189,"kind":2048,"name":"isTcpKeepAlive","url":"classes/consulclientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":190,"kind":2048,"name":"setTcpKeepAlive","url":"classes/consulclientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":191,"kind":2048,"name":"isTcpNoDelay","url":"classes/consulclientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":192,"kind":2048,"name":"setTcpNoDelay","url":"classes/consulclientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":193,"kind":2048,"name":"isTcpQuickAck","url":"classes/consulclientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":194,"kind":2048,"name":"setTcpQuickAck","url":"classes/consulclientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":195,"kind":2048,"name":"getTimeout","url":"classes/consulclientoptions.html#gettimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":196,"kind":2048,"name":"setTimeout","url":"classes/consulclientoptions.html#settimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":197,"kind":2048,"name":"getTrafficClass","url":"classes/consulclientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":198,"kind":2048,"name":"setTrafficClass","url":"classes/consulclientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":199,"kind":2048,"name":"isTrustAll","url":"classes/consulclientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":200,"kind":2048,"name":"setTrustAll","url":"classes/consulclientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":201,"kind":2048,"name":"getTrustStoreOptions","url":"classes/consulclientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":202,"kind":2048,"name":"setTrustStoreOptions","url":"classes/consulclientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":203,"kind":2048,"name":"isTryUseCompression","url":"classes/consulclientoptions.html#istryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":204,"kind":2048,"name":"setTryUseCompression","url":"classes/consulclientoptions.html#settryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":205,"kind":2048,"name":"tryUsePerFrameWebsocketCompression","url":"classes/consulclientoptions.html#tryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":206,"kind":2048,"name":"setTryUsePerFrameWebsocketCompression","url":"classes/consulclientoptions.html#settryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":207,"kind":2048,"name":"tryUsePerMessageWebsocketCompression","url":"classes/consulclientoptions.html#tryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":208,"kind":2048,"name":"setTryUsePerMessageWebsocketCompression","url":"classes/consulclientoptions.html#settryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":209,"kind":2048,"name":"isUseAlpn","url":"classes/consulclientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":210,"kind":2048,"name":"setUseAlpn","url":"classes/consulclientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":211,"kind":2048,"name":"isUsePooledBuffers","url":"classes/consulclientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":212,"kind":2048,"name":"setUsePooledBuffers","url":"classes/consulclientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":213,"kind":2048,"name":"getUserAgent","url":"classes/consulclientoptions.html#getuseragent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":214,"kind":2048,"name":"setUserAgent","url":"classes/consulclientoptions.html#setuseragent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":215,"kind":2048,"name":"isUserAgentEnabled","url":"classes/consulclientoptions.html#isuseragentenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":216,"kind":2048,"name":"setUserAgentEnabled","url":"classes/consulclientoptions.html#setuseragentenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":217,"kind":2048,"name":"isVerifyHost","url":"classes/consulclientoptions.html#isverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":218,"kind":2048,"name":"setVerifyHost","url":"classes/consulclientoptions.html#setverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":219,"kind":2048,"name":"getWebsocketCompressionAllowClientNoContext","url":"classes/consulclientoptions.html#getwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":220,"kind":2048,"name":"setWebsocketCompressionAllowClientNoContext","url":"classes/consulclientoptions.html#setwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":221,"kind":2048,"name":"getWebsocketCompressionLevel","url":"classes/consulclientoptions.html#getwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":222,"kind":2048,"name":"setWebsocketCompressionLevel","url":"classes/consulclientoptions.html#setwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":223,"kind":2048,"name":"getWebsocketCompressionRequestServerNoContext","url":"classes/consulclientoptions.html#getwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":224,"kind":2048,"name":"setWebsocketCompressionRequestServerNoContext","url":"classes/consulclientoptions.html#setwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClientOptions"},{"id":225,"kind":128,"name":"Coordinate","url":"classes/coordinate.html","classes":"tsd-kind-class"},{"id":226,"kind":512,"name":"constructor","url":"classes/coordinate.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Coordinate"},{"id":227,"kind":2048,"name":"getAdj","url":"classes/coordinate.html#getadj","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":228,"kind":2048,"name":"setAdj","url":"classes/coordinate.html#setadj","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":229,"kind":2048,"name":"getErr","url":"classes/coordinate.html#geterr","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":230,"kind":2048,"name":"setErr","url":"classes/coordinate.html#seterr","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":231,"kind":2048,"name":"getHeight","url":"classes/coordinate.html#getheight","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":232,"kind":2048,"name":"setHeight","url":"classes/coordinate.html#setheight","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":233,"kind":2048,"name":"getNode","url":"classes/coordinate.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":234,"kind":2048,"name":"setNode","url":"classes/coordinate.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":235,"kind":2048,"name":"getVec","url":"classes/coordinate.html#getvec","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":236,"kind":2048,"name":"setVec","url":"classes/coordinate.html#setvec","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Coordinate"},{"id":237,"kind":128,"name":"CoordinateList","url":"classes/coordinatelist.html","classes":"tsd-kind-class"},{"id":238,"kind":512,"name":"constructor","url":"classes/coordinatelist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CoordinateList"},{"id":239,"kind":2048,"name":"getIndex","url":"classes/coordinatelist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CoordinateList"},{"id":240,"kind":2048,"name":"setIndex","url":"classes/coordinatelist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CoordinateList"},{"id":241,"kind":2048,"name":"getList","url":"classes/coordinatelist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CoordinateList"},{"id":242,"kind":2048,"name":"setList","url":"classes/coordinatelist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CoordinateList"},{"id":243,"kind":128,"name":"DcCoordinates","url":"classes/dccoordinates.html","classes":"tsd-kind-class"},{"id":244,"kind":512,"name":"constructor","url":"classes/dccoordinates.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"DcCoordinates"},{"id":245,"kind":2048,"name":"getDatacenter","url":"classes/dccoordinates.html#getdatacenter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DcCoordinates"},{"id":246,"kind":2048,"name":"setDatacenter","url":"classes/dccoordinates.html#setdatacenter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DcCoordinates"},{"id":247,"kind":2048,"name":"getServers","url":"classes/dccoordinates.html#getservers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DcCoordinates"},{"id":248,"kind":2048,"name":"setServers","url":"classes/dccoordinates.html#setservers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DcCoordinates"},{"id":249,"kind":128,"name":"Event","url":"classes/event.html","classes":"tsd-kind-class"},{"id":250,"kind":512,"name":"constructor","url":"classes/event.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Event"},{"id":251,"kind":2048,"name":"getId","url":"classes/event.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":252,"kind":2048,"name":"setId","url":"classes/event.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":253,"kind":2048,"name":"getLTime","url":"classes/event.html#getltime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":254,"kind":2048,"name":"setLTime","url":"classes/event.html#setltime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":255,"kind":2048,"name":"getName","url":"classes/event.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":256,"kind":2048,"name":"setName","url":"classes/event.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":257,"kind":2048,"name":"getNode","url":"classes/event.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":258,"kind":2048,"name":"setNode","url":"classes/event.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":259,"kind":2048,"name":"getPayload","url":"classes/event.html#getpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":260,"kind":2048,"name":"setPayload","url":"classes/event.html#setpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":261,"kind":2048,"name":"getService","url":"classes/event.html#getservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":262,"kind":2048,"name":"setService","url":"classes/event.html#setservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":263,"kind":2048,"name":"getTag","url":"classes/event.html#gettag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":264,"kind":2048,"name":"setTag","url":"classes/event.html#settag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":265,"kind":2048,"name":"getVersion","url":"classes/event.html#getversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":266,"kind":2048,"name":"setVersion","url":"classes/event.html#setversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Event"},{"id":267,"kind":128,"name":"EventList","url":"classes/eventlist.html","classes":"tsd-kind-class"},{"id":268,"kind":512,"name":"constructor","url":"classes/eventlist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"EventList"},{"id":269,"kind":2048,"name":"getIndex","url":"classes/eventlist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventList"},{"id":270,"kind":2048,"name":"setIndex","url":"classes/eventlist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventList"},{"id":271,"kind":2048,"name":"getList","url":"classes/eventlist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventList"},{"id":272,"kind":2048,"name":"setList","url":"classes/eventlist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventList"},{"id":273,"kind":128,"name":"EventListOptions","url":"classes/eventlistoptions.html","classes":"tsd-kind-class"},{"id":274,"kind":512,"name":"constructor","url":"classes/eventlistoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"EventListOptions"},{"id":275,"kind":2048,"name":"getBlockingOptions","url":"classes/eventlistoptions.html#getblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventListOptions"},{"id":276,"kind":2048,"name":"setBlockingOptions","url":"classes/eventlistoptions.html#setblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventListOptions"},{"id":277,"kind":2048,"name":"getName","url":"classes/eventlistoptions.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventListOptions"},{"id":278,"kind":2048,"name":"setName","url":"classes/eventlistoptions.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventListOptions"},{"id":279,"kind":128,"name":"EventOptions","url":"classes/eventoptions.html","classes":"tsd-kind-class"},{"id":280,"kind":512,"name":"constructor","url":"classes/eventoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"EventOptions"},{"id":281,"kind":2048,"name":"getNode","url":"classes/eventoptions.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":282,"kind":2048,"name":"setNode","url":"classes/eventoptions.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":283,"kind":2048,"name":"getPayload","url":"classes/eventoptions.html#getpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":284,"kind":2048,"name":"setPayload","url":"classes/eventoptions.html#setpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":285,"kind":2048,"name":"getService","url":"classes/eventoptions.html#getservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":286,"kind":2048,"name":"setService","url":"classes/eventoptions.html#setservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":287,"kind":2048,"name":"getTag","url":"classes/eventoptions.html#gettag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":288,"kind":2048,"name":"setTag","url":"classes/eventoptions.html#settag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventOptions"},{"id":289,"kind":128,"name":"KeyValue","url":"classes/keyvalue.html","classes":"tsd-kind-class"},{"id":290,"kind":512,"name":"constructor","url":"classes/keyvalue.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"KeyValue"},{"id":291,"kind":2048,"name":"getCreateIndex","url":"classes/keyvalue.html#getcreateindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":292,"kind":2048,"name":"setCreateIndex","url":"classes/keyvalue.html#setcreateindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":293,"kind":2048,"name":"getFlags","url":"classes/keyvalue.html#getflags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":294,"kind":2048,"name":"setFlags","url":"classes/keyvalue.html#setflags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":295,"kind":2048,"name":"getKey","url":"classes/keyvalue.html#getkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":296,"kind":2048,"name":"setKey","url":"classes/keyvalue.html#setkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":297,"kind":2048,"name":"getLockIndex","url":"classes/keyvalue.html#getlockindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":298,"kind":2048,"name":"setLockIndex","url":"classes/keyvalue.html#setlockindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":299,"kind":2048,"name":"getModifyIndex","url":"classes/keyvalue.html#getmodifyindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":300,"kind":2048,"name":"setModifyIndex","url":"classes/keyvalue.html#setmodifyindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":301,"kind":2048,"name":"getSession","url":"classes/keyvalue.html#getsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":302,"kind":2048,"name":"setSession","url":"classes/keyvalue.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":303,"kind":2048,"name":"getValue","url":"classes/keyvalue.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":304,"kind":2048,"name":"setValue","url":"classes/keyvalue.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValue"},{"id":305,"kind":128,"name":"KeyValueList","url":"classes/keyvaluelist.html","classes":"tsd-kind-class"},{"id":306,"kind":512,"name":"constructor","url":"classes/keyvaluelist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"KeyValueList"},{"id":307,"kind":2048,"name":"getIndex","url":"classes/keyvaluelist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueList"},{"id":308,"kind":2048,"name":"setIndex","url":"classes/keyvaluelist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueList"},{"id":309,"kind":2048,"name":"getList","url":"classes/keyvaluelist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueList"},{"id":310,"kind":2048,"name":"setList","url":"classes/keyvaluelist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueList"},{"id":311,"kind":128,"name":"KeyValueOptions","url":"classes/keyvalueoptions.html","classes":"tsd-kind-class"},{"id":312,"kind":512,"name":"constructor","url":"classes/keyvalueoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":313,"kind":2048,"name":"getAcquireSession","url":"classes/keyvalueoptions.html#getacquiresession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":314,"kind":2048,"name":"setAcquireSession","url":"classes/keyvalueoptions.html#setacquiresession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":315,"kind":2048,"name":"getCasIndex","url":"classes/keyvalueoptions.html#getcasindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":316,"kind":2048,"name":"setCasIndex","url":"classes/keyvalueoptions.html#setcasindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":317,"kind":2048,"name":"getFlags","url":"classes/keyvalueoptions.html#getflags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":318,"kind":2048,"name":"setFlags","url":"classes/keyvalueoptions.html#setflags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":319,"kind":2048,"name":"getReleaseSession","url":"classes/keyvalueoptions.html#getreleasesession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":320,"kind":2048,"name":"setReleaseSession","url":"classes/keyvalueoptions.html#setreleasesession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KeyValueOptions"},{"id":321,"kind":128,"name":"MaintenanceOptions","url":"classes/maintenanceoptions.html","classes":"tsd-kind-class"},{"id":322,"kind":512,"name":"constructor","url":"classes/maintenanceoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":323,"kind":2048,"name":"isEnable","url":"classes/maintenanceoptions.html#isenable","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":324,"kind":2048,"name":"setEnable","url":"classes/maintenanceoptions.html#setenable","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":325,"kind":2048,"name":"getId","url":"classes/maintenanceoptions.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":326,"kind":2048,"name":"setId","url":"classes/maintenanceoptions.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":327,"kind":2048,"name":"getReason","url":"classes/maintenanceoptions.html#getreason","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":328,"kind":2048,"name":"setReason","url":"classes/maintenanceoptions.html#setreason","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MaintenanceOptions"},{"id":329,"kind":128,"name":"Node","url":"classes/node.html","classes":"tsd-kind-class"},{"id":330,"kind":512,"name":"constructor","url":"classes/node.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Node"},{"id":331,"kind":2048,"name":"getAddress","url":"classes/node.html#getaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":332,"kind":2048,"name":"setAddress","url":"classes/node.html#setaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":333,"kind":2048,"name":"getLanAddress","url":"classes/node.html#getlanaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":334,"kind":2048,"name":"setLanAddress","url":"classes/node.html#setlanaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":335,"kind":2048,"name":"getName","url":"classes/node.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":336,"kind":2048,"name":"setName","url":"classes/node.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":337,"kind":2048,"name":"getWanAddress","url":"classes/node.html#getwanaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":338,"kind":2048,"name":"setWanAddress","url":"classes/node.html#setwanaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":339,"kind":128,"name":"NodeList","url":"classes/nodelist.html","classes":"tsd-kind-class"},{"id":340,"kind":512,"name":"constructor","url":"classes/nodelist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"NodeList"},{"id":341,"kind":2048,"name":"getIndex","url":"classes/nodelist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeList"},{"id":342,"kind":2048,"name":"setIndex","url":"classes/nodelist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeList"},{"id":343,"kind":2048,"name":"getList","url":"classes/nodelist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeList"},{"id":344,"kind":2048,"name":"setList","url":"classes/nodelist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeList"},{"id":345,"kind":128,"name":"NodeQueryOptions","url":"classes/nodequeryoptions.html","classes":"tsd-kind-class"},{"id":346,"kind":512,"name":"constructor","url":"classes/nodequeryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":347,"kind":2048,"name":"getBlockingOptions","url":"classes/nodequeryoptions.html#getblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":348,"kind":2048,"name":"setBlockingOptions","url":"classes/nodequeryoptions.html#setblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":349,"kind":2048,"name":"getNear","url":"classes/nodequeryoptions.html#getnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":350,"kind":2048,"name":"setNear","url":"classes/nodequeryoptions.html#setnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NodeQueryOptions"},{"id":351,"kind":128,"name":"PreparedQueryDefinition","url":"classes/preparedquerydefinition.html","classes":"tsd-kind-class"},{"id":352,"kind":512,"name":"constructor","url":"classes/preparedquerydefinition.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":353,"kind":2048,"name":"getDcs","url":"classes/preparedquerydefinition.html#getdcs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":354,"kind":2048,"name":"setDcs","url":"classes/preparedquerydefinition.html#setdcs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":355,"kind":2048,"name":"getDnsTtl","url":"classes/preparedquerydefinition.html#getdnsttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":356,"kind":2048,"name":"setDnsTtl","url":"classes/preparedquerydefinition.html#setdnsttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":357,"kind":2048,"name":"getId","url":"classes/preparedquerydefinition.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":358,"kind":2048,"name":"setId","url":"classes/preparedquerydefinition.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":359,"kind":2048,"name":"getMeta","url":"classes/preparedquerydefinition.html#getmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":360,"kind":2048,"name":"setMeta","url":"classes/preparedquerydefinition.html#setmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":361,"kind":2048,"name":"getName","url":"classes/preparedquerydefinition.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":362,"kind":2048,"name":"setName","url":"classes/preparedquerydefinition.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":363,"kind":2048,"name":"getNearestN","url":"classes/preparedquerydefinition.html#getnearestn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":364,"kind":2048,"name":"setNearestN","url":"classes/preparedquerydefinition.html#setnearestn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":365,"kind":2048,"name":"getPassing","url":"classes/preparedquerydefinition.html#getpassing","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":366,"kind":2048,"name":"setPassing","url":"classes/preparedquerydefinition.html#setpassing","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":367,"kind":2048,"name":"getService","url":"classes/preparedquerydefinition.html#getservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":368,"kind":2048,"name":"setService","url":"classes/preparedquerydefinition.html#setservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":369,"kind":2048,"name":"getSession","url":"classes/preparedquerydefinition.html#getsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":370,"kind":2048,"name":"setSession","url":"classes/preparedquerydefinition.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":371,"kind":2048,"name":"getTags","url":"classes/preparedquerydefinition.html#gettags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":372,"kind":2048,"name":"setTags","url":"classes/preparedquerydefinition.html#settags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":373,"kind":2048,"name":"getTemplateRegexp","url":"classes/preparedquerydefinition.html#gettemplateregexp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":374,"kind":2048,"name":"setTemplateRegexp","url":"classes/preparedquerydefinition.html#settemplateregexp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":375,"kind":2048,"name":"getTemplateType","url":"classes/preparedquerydefinition.html#gettemplatetype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":376,"kind":2048,"name":"setTemplateType","url":"classes/preparedquerydefinition.html#settemplatetype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":377,"kind":2048,"name":"getToken","url":"classes/preparedquerydefinition.html#gettoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":378,"kind":2048,"name":"setToken","url":"classes/preparedquerydefinition.html#settoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryDefinition"},{"id":379,"kind":128,"name":"PreparedQueryExecuteOptions","url":"classes/preparedqueryexecuteoptions.html","classes":"tsd-kind-class"},{"id":380,"kind":512,"name":"constructor","url":"classes/preparedqueryexecuteoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":381,"kind":2048,"name":"getLimit","url":"classes/preparedqueryexecuteoptions.html#getlimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":382,"kind":2048,"name":"setLimit","url":"classes/preparedqueryexecuteoptions.html#setlimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":383,"kind":2048,"name":"getNear","url":"classes/preparedqueryexecuteoptions.html#getnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":384,"kind":2048,"name":"setNear","url":"classes/preparedqueryexecuteoptions.html#setnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteOptions"},{"id":385,"kind":128,"name":"PreparedQueryExecuteResponse","url":"classes/preparedqueryexecuteresponse.html","classes":"tsd-kind-class"},{"id":386,"kind":512,"name":"constructor","url":"classes/preparedqueryexecuteresponse.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":387,"kind":2048,"name":"getDc","url":"classes/preparedqueryexecuteresponse.html#getdc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":388,"kind":2048,"name":"setDc","url":"classes/preparedqueryexecuteresponse.html#setdc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":389,"kind":2048,"name":"getDnsTtl","url":"classes/preparedqueryexecuteresponse.html#getdnsttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":390,"kind":2048,"name":"setDnsTtl","url":"classes/preparedqueryexecuteresponse.html#setdnsttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":391,"kind":2048,"name":"getFailovers","url":"classes/preparedqueryexecuteresponse.html#getfailovers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":392,"kind":2048,"name":"setFailovers","url":"classes/preparedqueryexecuteresponse.html#setfailovers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":393,"kind":2048,"name":"getNodes","url":"classes/preparedqueryexecuteresponse.html#getnodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":394,"kind":2048,"name":"setNodes","url":"classes/preparedqueryexecuteresponse.html#setnodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":395,"kind":2048,"name":"getService","url":"classes/preparedqueryexecuteresponse.html#getservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":396,"kind":2048,"name":"setService","url":"classes/preparedqueryexecuteresponse.html#setservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PreparedQueryExecuteResponse"},{"id":397,"kind":128,"name":"Service","url":"classes/service.html","classes":"tsd-kind-class"},{"id":398,"kind":512,"name":"constructor","url":"classes/service.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Service"},{"id":399,"kind":2048,"name":"getAddress","url":"classes/service.html#getaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":400,"kind":2048,"name":"setAddress","url":"classes/service.html#setaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":401,"kind":2048,"name":"getId","url":"classes/service.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":402,"kind":2048,"name":"setId","url":"classes/service.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":403,"kind":2048,"name":"getMeta","url":"classes/service.html#getmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":404,"kind":2048,"name":"setMeta","url":"classes/service.html#setmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":405,"kind":2048,"name":"getName","url":"classes/service.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":406,"kind":2048,"name":"setName","url":"classes/service.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":407,"kind":2048,"name":"getNode","url":"classes/service.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":408,"kind":2048,"name":"setNode","url":"classes/service.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":409,"kind":2048,"name":"getNodeAddress","url":"classes/service.html#getnodeaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":410,"kind":2048,"name":"setNodeAddress","url":"classes/service.html#setnodeaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":411,"kind":2048,"name":"getPort","url":"classes/service.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":412,"kind":2048,"name":"setPort","url":"classes/service.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":413,"kind":2048,"name":"getTags","url":"classes/service.html#gettags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":414,"kind":2048,"name":"setTags","url":"classes/service.html#settags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Service"},{"id":415,"kind":128,"name":"ServiceEntry","url":"classes/serviceentry.html","classes":"tsd-kind-class"},{"id":416,"kind":512,"name":"constructor","url":"classes/serviceentry.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ServiceEntry"},{"id":417,"kind":2048,"name":"getChecks","url":"classes/serviceentry.html#getchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntry"},{"id":418,"kind":2048,"name":"setChecks","url":"classes/serviceentry.html#setchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntry"},{"id":419,"kind":2048,"name":"getNode","url":"classes/serviceentry.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntry"},{"id":420,"kind":2048,"name":"setNode","url":"classes/serviceentry.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntry"},{"id":421,"kind":2048,"name":"getService","url":"classes/serviceentry.html#getservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntry"},{"id":422,"kind":2048,"name":"setService","url":"classes/serviceentry.html#setservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntry"},{"id":423,"kind":128,"name":"ServiceEntryList","url":"classes/serviceentrylist.html","classes":"tsd-kind-class"},{"id":424,"kind":512,"name":"constructor","url":"classes/serviceentrylist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":425,"kind":2048,"name":"getIndex","url":"classes/serviceentrylist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":426,"kind":2048,"name":"setIndex","url":"classes/serviceentrylist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":427,"kind":2048,"name":"getList","url":"classes/serviceentrylist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":428,"kind":2048,"name":"setList","url":"classes/serviceentrylist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceEntryList"},{"id":429,"kind":128,"name":"ServiceList","url":"classes/servicelist.html","classes":"tsd-kind-class"},{"id":430,"kind":512,"name":"constructor","url":"classes/servicelist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ServiceList"},{"id":431,"kind":2048,"name":"getIndex","url":"classes/servicelist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceList"},{"id":432,"kind":2048,"name":"setIndex","url":"classes/servicelist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceList"},{"id":433,"kind":2048,"name":"getList","url":"classes/servicelist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceList"},{"id":434,"kind":2048,"name":"setList","url":"classes/servicelist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceList"},{"id":435,"kind":128,"name":"ServiceOptions","url":"classes/serviceoptions.html","classes":"tsd-kind-class"},{"id":436,"kind":512,"name":"constructor","url":"classes/serviceoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ServiceOptions"},{"id":437,"kind":2048,"name":"getAddress","url":"classes/serviceoptions.html#getaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":438,"kind":2048,"name":"setAddress","url":"classes/serviceoptions.html#setaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":439,"kind":2048,"name":"getCheckOptions","url":"classes/serviceoptions.html#getcheckoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":440,"kind":2048,"name":"setCheckOptions","url":"classes/serviceoptions.html#setcheckoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":441,"kind":2048,"name":"getId","url":"classes/serviceoptions.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":442,"kind":2048,"name":"setId","url":"classes/serviceoptions.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":443,"kind":2048,"name":"getMeta","url":"classes/serviceoptions.html#getmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":444,"kind":2048,"name":"setMeta","url":"classes/serviceoptions.html#setmeta","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":445,"kind":2048,"name":"getName","url":"classes/serviceoptions.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":446,"kind":2048,"name":"setName","url":"classes/serviceoptions.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":447,"kind":2048,"name":"getPort","url":"classes/serviceoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":448,"kind":2048,"name":"setPort","url":"classes/serviceoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":449,"kind":2048,"name":"getTags","url":"classes/serviceoptions.html#gettags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":450,"kind":2048,"name":"setTags","url":"classes/serviceoptions.html#settags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceOptions"},{"id":451,"kind":128,"name":"ServiceQueryOptions","url":"classes/servicequeryoptions.html","classes":"tsd-kind-class"},{"id":452,"kind":512,"name":"constructor","url":"classes/servicequeryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":453,"kind":2048,"name":"getBlockingOptions","url":"classes/servicequeryoptions.html#getblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":454,"kind":2048,"name":"setBlockingOptions","url":"classes/servicequeryoptions.html#setblockingoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":455,"kind":2048,"name":"getNear","url":"classes/servicequeryoptions.html#getnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":456,"kind":2048,"name":"setNear","url":"classes/servicequeryoptions.html#setnear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":457,"kind":2048,"name":"getTag","url":"classes/servicequeryoptions.html#gettag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":458,"kind":2048,"name":"setTag","url":"classes/servicequeryoptions.html#settag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceQueryOptions"},{"id":459,"kind":128,"name":"Session","url":"classes/session.html","classes":"tsd-kind-class"},{"id":460,"kind":512,"name":"constructor","url":"classes/session.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Session"},{"id":461,"kind":2048,"name":"getChecks","url":"classes/session.html#getchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":462,"kind":2048,"name":"setChecks","url":"classes/session.html#setchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":463,"kind":2048,"name":"getCreateIndex","url":"classes/session.html#getcreateindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":464,"kind":2048,"name":"setCreateIndex","url":"classes/session.html#setcreateindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":465,"kind":2048,"name":"getId","url":"classes/session.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":466,"kind":2048,"name":"setId","url":"classes/session.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":467,"kind":2048,"name":"getIndex","url":"classes/session.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":468,"kind":2048,"name":"setIndex","url":"classes/session.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":469,"kind":2048,"name":"getLockDelay","url":"classes/session.html#getlockdelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":470,"kind":2048,"name":"setLockDelay","url":"classes/session.html#setlockdelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":471,"kind":2048,"name":"getNode","url":"classes/session.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":472,"kind":2048,"name":"setNode","url":"classes/session.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":473,"kind":128,"name":"SessionList","url":"classes/sessionlist.html","classes":"tsd-kind-class"},{"id":474,"kind":512,"name":"constructor","url":"classes/sessionlist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SessionList"},{"id":475,"kind":2048,"name":"getIndex","url":"classes/sessionlist.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionList"},{"id":476,"kind":2048,"name":"setIndex","url":"classes/sessionlist.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionList"},{"id":477,"kind":2048,"name":"getList","url":"classes/sessionlist.html#getlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionList"},{"id":478,"kind":2048,"name":"setList","url":"classes/sessionlist.html#setlist","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionList"},{"id":479,"kind":128,"name":"SessionOptions","url":"classes/sessionoptions.html","classes":"tsd-kind-class"},{"id":480,"kind":512,"name":"constructor","url":"classes/sessionoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SessionOptions"},{"id":481,"kind":2048,"name":"getBehavior","url":"classes/sessionoptions.html#getbehavior","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":482,"kind":2048,"name":"setBehavior","url":"classes/sessionoptions.html#setbehavior","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":483,"kind":2048,"name":"getChecks","url":"classes/sessionoptions.html#getchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":484,"kind":2048,"name":"setChecks","url":"classes/sessionoptions.html#setchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":485,"kind":2048,"name":"getLockDelay","url":"classes/sessionoptions.html#getlockdelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":486,"kind":2048,"name":"setLockDelay","url":"classes/sessionoptions.html#setlockdelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":487,"kind":2048,"name":"getName","url":"classes/sessionoptions.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":488,"kind":2048,"name":"setName","url":"classes/sessionoptions.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":489,"kind":2048,"name":"getNode","url":"classes/sessionoptions.html#getnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":490,"kind":2048,"name":"setNode","url":"classes/sessionoptions.html#setnode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":491,"kind":2048,"name":"getTtl","url":"classes/sessionoptions.html#getttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":492,"kind":2048,"name":"setTtl","url":"classes/sessionoptions.html#setttl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SessionOptions"},{"id":493,"kind":128,"name":"TxnError","url":"classes/txnerror.html","classes":"tsd-kind-class"},{"id":494,"kind":512,"name":"constructor","url":"classes/txnerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TxnError"},{"id":495,"kind":2048,"name":"getOpIndex","url":"classes/txnerror.html#getopindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnError"},{"id":496,"kind":2048,"name":"setOpIndex","url":"classes/txnerror.html#setopindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnError"},{"id":497,"kind":2048,"name":"getWhat","url":"classes/txnerror.html#getwhat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnError"},{"id":498,"kind":2048,"name":"setWhat","url":"classes/txnerror.html#setwhat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnError"},{"id":499,"kind":128,"name":"TxnKVOperation","url":"classes/txnkvoperation.html","classes":"tsd-kind-class"},{"id":500,"kind":512,"name":"constructor","url":"classes/txnkvoperation.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":501,"kind":2048,"name":"getFlags","url":"classes/txnkvoperation.html#getflags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":502,"kind":2048,"name":"setFlags","url":"classes/txnkvoperation.html#setflags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":503,"kind":2048,"name":"getIndex","url":"classes/txnkvoperation.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":504,"kind":2048,"name":"setIndex","url":"classes/txnkvoperation.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":505,"kind":2048,"name":"getKey","url":"classes/txnkvoperation.html#getkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":506,"kind":2048,"name":"setKey","url":"classes/txnkvoperation.html#setkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":507,"kind":2048,"name":"getSession","url":"classes/txnkvoperation.html#getsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":508,"kind":2048,"name":"setSession","url":"classes/txnkvoperation.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":509,"kind":2048,"name":"getType","url":"classes/txnkvoperation.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":510,"kind":2048,"name":"setType","url":"classes/txnkvoperation.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":511,"kind":2048,"name":"getValue","url":"classes/txnkvoperation.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":512,"kind":2048,"name":"setValue","url":"classes/txnkvoperation.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnKVOperation"},{"id":513,"kind":128,"name":"TxnRequest","url":"classes/txnrequest.html","classes":"tsd-kind-class"},{"id":514,"kind":512,"name":"constructor","url":"classes/txnrequest.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TxnRequest"},{"id":515,"kind":2048,"name":"getOperationsSize","url":"classes/txnrequest.html#getoperationssize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnRequest"},{"id":516,"kind":128,"name":"TxnResponse","url":"classes/txnresponse.html","classes":"tsd-kind-class"},{"id":517,"kind":512,"name":"constructor","url":"classes/txnresponse.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TxnResponse"},{"id":518,"kind":2048,"name":"getErrors","url":"classes/txnresponse.html#geterrors","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnResponse"},{"id":519,"kind":2048,"name":"addError","url":"classes/txnresponse.html#adderror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnResponse"},{"id":520,"kind":2048,"name":"getErrorsSize","url":"classes/txnresponse.html#geterrorssize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnResponse"},{"id":521,"kind":2048,"name":"getResultsSize","url":"classes/txnresponse.html#getresultssize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TxnResponse"},{"id":522,"kind":128,"name":"ConsulClient","url":"classes/consulclient.html","classes":"tsd-kind-class"},{"id":523,"kind":2048,"name":"create","url":"classes/consulclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ConsulClient"},{"id":524,"kind":2048,"name":"agentInfo","url":"classes/consulclient.html#agentinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":525,"kind":2048,"name":"coordinateNodes","url":"classes/consulclient.html#coordinatenodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":526,"kind":2048,"name":"coordinateNodesWithOptions","url":"classes/consulclient.html#coordinatenodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":527,"kind":2048,"name":"coordinateDatacenters","url":"classes/consulclient.html#coordinatedatacenters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":528,"kind":2048,"name":"getKeys","url":"classes/consulclient.html#getkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":529,"kind":2048,"name":"getKeysWithOptions","url":"classes/consulclient.html#getkeyswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":530,"kind":2048,"name":"getValue","url":"classes/consulclient.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":531,"kind":2048,"name":"getValueWithOptions","url":"classes/consulclient.html#getvaluewithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":532,"kind":2048,"name":"deleteValue","url":"classes/consulclient.html#deletevalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":533,"kind":2048,"name":"getValues","url":"classes/consulclient.html#getvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":534,"kind":2048,"name":"getValuesWithOptions","url":"classes/consulclient.html#getvalueswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":535,"kind":2048,"name":"deleteValues","url":"classes/consulclient.html#deletevalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":536,"kind":2048,"name":"putValue","url":"classes/consulclient.html#putvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":537,"kind":2048,"name":"putValueWithOptions","url":"classes/consulclient.html#putvaluewithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":538,"kind":2048,"name":"transaction","url":"classes/consulclient.html#transaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":539,"kind":2048,"name":"createAclToken","url":"classes/consulclient.html#createacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":540,"kind":2048,"name":"updateAclToken","url":"classes/consulclient.html#updateacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":541,"kind":2048,"name":"cloneAclToken","url":"classes/consulclient.html#cloneacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":542,"kind":2048,"name":"listAclTokens","url":"classes/consulclient.html#listacltokens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":543,"kind":2048,"name":"infoAclToken","url":"classes/consulclient.html#infoacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":544,"kind":2048,"name":"destroyAclToken","url":"classes/consulclient.html#destroyacltoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":545,"kind":2048,"name":"fireEvent","url":"classes/consulclient.html#fireevent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":546,"kind":2048,"name":"fireEventWithOptions","url":"classes/consulclient.html#fireeventwithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":547,"kind":2048,"name":"listEvents","url":"classes/consulclient.html#listevents","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":548,"kind":2048,"name":"listEventsWithOptions","url":"classes/consulclient.html#listeventswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":549,"kind":2048,"name":"registerService","url":"classes/consulclient.html#registerservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":550,"kind":2048,"name":"maintenanceService","url":"classes/consulclient.html#maintenanceservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":551,"kind":2048,"name":"deregisterService","url":"classes/consulclient.html#deregisterservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":552,"kind":2048,"name":"catalogServiceNodes","url":"classes/consulclient.html#catalogservicenodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":553,"kind":2048,"name":"catalogServiceNodesWithOptions","url":"classes/consulclient.html#catalogservicenodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":554,"kind":2048,"name":"catalogDatacenters","url":"classes/consulclient.html#catalogdatacenters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":555,"kind":2048,"name":"catalogNodes","url":"classes/consulclient.html#catalognodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":556,"kind":2048,"name":"catalogNodesWithOptions","url":"classes/consulclient.html#catalognodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":557,"kind":2048,"name":"healthChecks","url":"classes/consulclient.html#healthchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":558,"kind":2048,"name":"healthChecksWithOptions","url":"classes/consulclient.html#healthcheckswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":559,"kind":2048,"name":"healthState","url":"classes/consulclient.html#healthstate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":560,"kind":2048,"name":"healthStateWithOptions","url":"classes/consulclient.html#healthstatewithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":561,"kind":2048,"name":"healthServiceNodes","url":"classes/consulclient.html#healthservicenodes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":562,"kind":2048,"name":"healthServiceNodesWithOptions","url":"classes/consulclient.html#healthservicenodeswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":563,"kind":2048,"name":"catalogServices","url":"classes/consulclient.html#catalogservices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":564,"kind":2048,"name":"catalogServicesWithOptions","url":"classes/consulclient.html#catalogserviceswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":565,"kind":2048,"name":"catalogNodeServices","url":"classes/consulclient.html#catalognodeservices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":566,"kind":2048,"name":"catalogNodeServicesWithOptions","url":"classes/consulclient.html#catalognodeserviceswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":567,"kind":2048,"name":"localServices","url":"classes/consulclient.html#localservices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":568,"kind":2048,"name":"localChecks","url":"classes/consulclient.html#localchecks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":569,"kind":2048,"name":"registerCheck","url":"classes/consulclient.html#registercheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":570,"kind":2048,"name":"deregisterCheck","url":"classes/consulclient.html#deregistercheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":571,"kind":2048,"name":"passCheck","url":"classes/consulclient.html#passcheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":572,"kind":2048,"name":"passCheckWithNote","url":"classes/consulclient.html#passcheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":573,"kind":2048,"name":"warnCheck","url":"classes/consulclient.html#warncheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":574,"kind":2048,"name":"warnCheckWithNote","url":"classes/consulclient.html#warncheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":575,"kind":2048,"name":"failCheck","url":"classes/consulclient.html#failcheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":576,"kind":2048,"name":"failCheckWithNote","url":"classes/consulclient.html#failcheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":577,"kind":2048,"name":"updateCheck","url":"classes/consulclient.html#updatecheck","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":578,"kind":2048,"name":"updateCheckWithNote","url":"classes/consulclient.html#updatecheckwithnote","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":579,"kind":2048,"name":"leaderStatus","url":"classes/consulclient.html#leaderstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":580,"kind":2048,"name":"peersStatus","url":"classes/consulclient.html#peersstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":581,"kind":2048,"name":"createSession","url":"classes/consulclient.html#createsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":582,"kind":2048,"name":"createSessionWithOptions","url":"classes/consulclient.html#createsessionwithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":583,"kind":2048,"name":"infoSession","url":"classes/consulclient.html#infosession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":584,"kind":2048,"name":"infoSessionWithOptions","url":"classes/consulclient.html#infosessionwithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":585,"kind":2048,"name":"renewSession","url":"classes/consulclient.html#renewsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":586,"kind":2048,"name":"listSessions","url":"classes/consulclient.html#listsessions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":587,"kind":2048,"name":"listSessionsWithOptions","url":"classes/consulclient.html#listsessionswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":588,"kind":2048,"name":"listNodeSessions","url":"classes/consulclient.html#listnodesessions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":589,"kind":2048,"name":"listNodeSessionsWithOptions","url":"classes/consulclient.html#listnodesessionswithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":590,"kind":2048,"name":"destroySession","url":"classes/consulclient.html#destroysession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":591,"kind":2048,"name":"createPreparedQuery","url":"classes/consulclient.html#createpreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":592,"kind":2048,"name":"getPreparedQuery","url":"classes/consulclient.html#getpreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":593,"kind":2048,"name":"getAllPreparedQueries","url":"classes/consulclient.html#getallpreparedqueries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":594,"kind":2048,"name":"updatePreparedQuery","url":"classes/consulclient.html#updatepreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":595,"kind":2048,"name":"deletePreparedQuery","url":"classes/consulclient.html#deletepreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":596,"kind":2048,"name":"executePreparedQuery","url":"classes/consulclient.html#executepreparedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":597,"kind":2048,"name":"executePreparedQueryWithOptions","url":"classes/consulclient.html#executepreparedquerywithoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":598,"kind":2048,"name":"close","url":"classes/consulclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ConsulClient"},{"id":599,"kind":128,"name":"Watch","url":"classes/watch.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":600,"kind":2048,"name":"key","url":"classes/watch.html#key","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":601,"kind":2048,"name":"keyPrefix","url":"classes/watch.html#keyprefix","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":602,"kind":2048,"name":"services","url":"classes/watch.html#services","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":603,"kind":2048,"name":"service","url":"classes/watch.html#service","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":604,"kind":2048,"name":"events","url":"classes/watch.html#events","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":605,"kind":2048,"name":"nodes","url":"classes/watch.html#nodes","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Watch"},{"id":606,"kind":2048,"name":"setHandler","url":"classes/watch.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Watch"},{"id":607,"kind":2048,"name":"start","url":"classes/watch.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Watch"},{"id":608,"kind":2048,"name":"stop","url":"classes/watch.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Watch"},{"id":609,"kind":128,"name":"WatchResult","url":"classes/watchresult.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":610,"kind":2048,"name":"prevResult","url":"classes/watchresult.html#prevresult","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":611,"kind":2048,"name":"nextResult","url":"classes/watchresult.html#nextresult","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":612,"kind":2048,"name":"cause","url":"classes/watchresult.html#cause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":613,"kind":2048,"name":"succeeded","url":"classes/watchresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"},{"id":614,"kind":2048,"name":"failed","url":"classes/watchresult.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WatchResult"}]}; \ No newline at end of file diff --git a/docs/@vertx/consul-client/classes/acltoken.html b/docs/@vertx/consul-client/classes/acltoken.html index 51c1e24d6..d26e6cb34 100644 --- a/docs/@vertx/consul-client/classes/acltoken.html +++ b/docs/@vertx/consul-client/classes/acltoken.html @@ -77,110 +77,283 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set ID of token

    -
    -
    -
    param
    -

    ID of token

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns AclToken

      +
      • +
    • + +

      Parameters

      + +

      Returns AclToken

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set name of token

    -
    -
    -
    param
    -

    name of token

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set ID of token

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    rules

    -
    rules: string
    - -
    -
    -

    Set rules for token

    -
    -
    -
    param
    -

    rules for token

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set name of token

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    type

    -
    type: AclTokenType
    - -
    -
    -

    Set type of token

    -
    -
    -
    param
    -

    type of token

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getRules

    +
      +
    • getRules(): string
      • +
    +
      +
    • + +
      +
      +

      Set rules for token

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getType

    +
      +
    • getType(): AclTokenType
      • +
    +
      +
    • + +
      +
      +

      Set type of token

      +
      +
      +

      Returns AclTokenType

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set ID of token

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        ID of token

        +
        +
        • +
      +

      Returns AclToken

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Set name of token

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of token

        +
        +
        • +
      +

      Returns AclToken

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setRules

    + +
      +
    • + +
      +
      +

      Set rules for token

      +
      +
      +

      Parameters

      +
        +
      • +
        rules: string
        +
        +

        rules for token

        +
        +
        • +
      +

      Returns AclToken

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setType

    +
      +
    • setType(type: AclTokenType): AclToken
      • +
    +
      +
    • + +
      +
      +

      Set type of token

      +
      +
      +

      Parameters

      +
        +
      • +
        type: AclTokenType
        +
        +

        type of token

        +
        +
        • +
      +

      Returns AclToken

      +

      reference to this, for fluency

      +
      • +
    @@ -199,17 +372,32 @@

    type

  • AclToken
    • @@ -326,10 +514,10 @@

    type

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/blockingqueryoptions.html b/docs/@vertx/consul-client/classes/blockingqueryoptions.html index 4bd622690..8eb92e4d3 100644 --- a/docs/@vertx/consul-client/classes/blockingqueryoptions.html +++ b/docs/@vertx/consul-client/classes/blockingqueryoptions.html @@ -77,64 +77,173 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set index indicating that the client wishes to wait for any changes subsequent to that index.

    -
    -
    -
    param
    -

    the index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    wait

    -
    wait: string
    - -
    -
    -

    Specifying a maximum duration for the blocking request. This is limited to 10 minutes. - If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" - (i.e., 10 seconds or 5 minutes, respectively).

    -
    -
    -
    param
    -

    wait period

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set index indicating that the client wishes to wait for any changes subsequent to that index.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getWait

    +
      +
    • getWait(): string
      • +
    +
      +
    • + +
      +
      +

      Specifying a maximum duration for the blocking request. This is limited to 10 minutes. + If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" + (i.e., 10 seconds or 5 minutes, respectively).

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set index indicating that the client wishes to wait for any changes subsequent to that index.

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the index

        +
        +
        • +
      +

      Returns BlockingQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setWait

    + +
      +
    • + +
      +
      +

      Specifying a maximum duration for the blocking request. This is limited to 10 minutes. + If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" + (i.e., 10 seconds or 5 minutes, respectively).

      +
      +
      +

      Parameters

      +
        +
      • +
        wait: string
        +
        +

        wait period

        +
        +
        • +
      +

      Returns BlockingQueryOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -156,11 +265,20 @@

    wait

  • BlockingQueryOptions
    • @@ -274,10 +392,10 @@

    wait

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/check.html b/docs/@vertx/consul-client/classes/check.html index efd40e332..dbdf6967e 100644 --- a/docs/@vertx/consul-client/classes/check.html +++ b/docs/@vertx/consul-client/classes/check.html @@ -77,206 +77,511 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set the ID of check

    -
    -
    -
    param
    -

    the ID of check

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Check

      +
      • +
    • + +

      Parameters

      + +

      Returns Check

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set the name of check

    -
    -
    -
    param
    -

    the name of check

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of check

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    nodeName

    -
    nodeName: string
    - -
    -
    -

    Set the name of node

    -
    -
    -
    param
    -

    the name of node

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the name of check

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    notes

    -
    notes: string
    - -
    -
    -

    Set the human-readable note of check

    -
    -
    -
    param
    -

    the human-readable note of check

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNodeName

    +
      +
    • getNodeName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the name of node

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    output

    -
    output: string
    - -
    -
    -

    Set the output of check

    -
    -
    -
    param
    -

    the output of check

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNotes

    +
      +
    • getNotes(): string
      • +
    +
      +
    • + +
      +
      +

      Set the human-readable note of check

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    serviceId

    -
    serviceId: string
    - -
    -
    -

    Set the ID of service with which this check associated

    -
    -
    -
    param
    -

    the ID of service with which this check associated

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getOutput

    +
      +
    • getOutput(): string
      • +
    +
      +
    • + +
      +
      +

      Set the output of check

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    serviceName

    -
    serviceName: string
    - -
    -
    -

    Set the name of service with which this check associated

    -
    -
    -
    param
    -

    the name of service with which this check associated

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getServiceId

    +
      +
    • getServiceId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of service with which this check associated

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    status

    -
    status: CheckStatus
    - -
    -
    -

    Set the status of check

    -
    -
    -
    param
    -

    the status of check

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getServiceName

    +
      +
    • getServiceName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the name of service with which this check associated

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getStatus

    +
      +
    • getStatus(): CheckStatus
      • +
    +
      +
    • + +
      +
      +

      Set the status of check

      +
      +
      +

      Returns CheckStatus

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    +
      +
    • setId(id: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the ID of check

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the ID of check

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    +
      +
    • setName(name: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the name of check

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        the name of check

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNodeName

    +
      +
    • setNodeName(nodeName: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the name of node

      +
      +
      +

      Parameters

      +
        +
      • +
        nodeName: string
        +
        +

        the name of node

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNotes

    +
      +
    • setNotes(notes: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the human-readable note of check

      +
      +
      +

      Parameters

      +
        +
      • +
        notes: string
        +
        +

        the human-readable note of check

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setOutput

    +
      +
    • setOutput(output: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the output of check

      +
      +
      +

      Parameters

      +
        +
      • +
        output: string
        +
        +

        the output of check

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setServiceId

    +
      +
    • setServiceId(serviceId: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the ID of service with which this check associated

      +
      +
      +

      Parameters

      +
        +
      • +
        serviceId: string
        +
        +

        the ID of service with which this check associated

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setServiceName

    +
      +
    • setServiceName(serviceName: string): Check
      • +
    +
      +
    • + +
      +
      +

      Set the name of service with which this check associated

      +
      +
      +

      Parameters

      +
        +
      • +
        serviceName: string
        +
        +

        the name of service with which this check associated

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setStatus

    +
      +
    • setStatus(status: CheckStatus): Check
      • +
    +
      +
    • + +
      +
      +

      Set the status of check

      +
      +
      +

      Parameters

      +
        +
      • +
        status: CheckStatus
        +
        +

        the status of check

        +
        +
        • +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    @@ -301,29 +606,56 @@

    status

  • Check
    • @@ -434,10 +766,10 @@

    status

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/checklist.html b/docs/@vertx/consul-client/classes/checklist.html index 7f02cca3f..c1553312d 100644 --- a/docs/@vertx/consul-client/classes/checklist.html +++ b/docs/@vertx/consul-client/classes/checklist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested list of checks

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns CheckList

      +
      • +
    • + +

      Parameters

      + +

      Returns CheckList

      +
      • +
    -
    - -

    list

    -
    list: Check
    - -
    -
    -

    Set list of checks

    -
    -
    -
    param
    -

    the list of checks

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of checks

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of checks

      +
      +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of checks

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns CheckList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of checks

      +
      +
      +

      Parameters

      +
        +
      • +
        list: Check
        +
        +

        the list of checks

        +
        +
        • +
      +

      Returns CheckList

      +

      reference to this, for fluency

      +
      • +
    @@ -160,11 +267,20 @@

    list

  • CheckList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/checkoptions.html b/docs/@vertx/consul-client/classes/checkoptions.html index fbf4e631a..22d125729 100644 --- a/docs/@vertx/consul-client/classes/checkoptions.html +++ b/docs/@vertx/consul-client/classes/checkoptions.html @@ -77,286 +77,868 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    deregisterAfter

    -
    deregisterAfter: string
    - -
    -
    -

    Set deregister timeout. This is optional field, which is a timeout in the same time format as Interval and TTL. - If a check is associated with a service and has the critical state for more than this configured value, - then its associated service (and all of its associated checks) will automatically be deregistered. - The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, - so it may take slightly longer than the configured timeout to trigger the deregistration. - This should generally be configured with a timeout that's much, much longer than any expected recoverable outage - for the given service.

    -
    -
    -
    param
    -

    timeout

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    http

    -
    http: string
    - -
    -
    -

    Set HTTP address to check. Also you should set checking interval

    -
    -
    -
    param
    -

    HTTP address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getDeregisterAfter

    +
      +
    • getDeregisterAfter(): string
      • +
    +
      +
    • + +
      +
      +

      Set deregister timeout. This is optional field, which is a timeout in the same time format as Interval and TTL. + If a check is associated with a service and has the critical state for more than this configured value, + then its associated service (and all of its associated checks) will automatically be deregistered. + The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, + so it may take slightly longer than the configured timeout to trigger the deregistration. + This should generally be configured with a timeout that's much, much longer than any expected recoverable outage + for the given service.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set check ID

    -
    -
    -
    param
    -

    check ID

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getGrpc

    +
      +
    • getGrpc(): string
      • +
    +
      +
    • + +
      +
      +

      Specifies a gRPC check's endpoint that supports the standard + gRPC health checking protocol. + The state of the check will be updated at the given Interval by probing the configured endpoint. + The endpoint must be represented as {@code address:port/service}

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    interval

    -
    interval: string
    - -
    -
    -

    Set checking interval

    -
    -
    -
    param
    -

    checking interval in Go's time format which is sequence of decimal numbers, - each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". - Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h"

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getHttp

    +
      +
    • getHttp(): string
      • +
    +
      +
    • + +
      +
      +

      Set HTTP address to check. Also you should set checking interval

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set check name. This is mandatory field

    -
    -
    -
    param
    -

    check name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set check ID

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    notes

    -
    notes: string
    - -
    -
    -

    Set check notes

    -
    -
    -
    param
    -

    check notes

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getInterval

    +
      +
    • getInterval(): string
      • +
    +
      +
    • + +
      +
      +

      Set checking interval

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    script

    -
    script: string
    - -
    -
    -

    Set path to checking script. Also you should set checking interval

    -
    -
    -
    param
    -

    path to script

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set check name. This is mandatory field

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    serviceId

    -
    serviceId: string
    - -
    -
    -

    Set the service ID to associate the registered check with an existing service provided by the agent.

    -
    -
    -
    param
    -

    the service ID

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNotes

    +
      +
    • getNotes(): string
      • +
    +
      +
    • + +
      +
      +

      Set check notes

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    status

    -
    status: CheckStatus
    - -
    -
    -

    Set the check status to specify the initial state of the health check.

    -
    -
    -
    param
    -

    the check status

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getScriptArgs

    +
      +
    • getScriptArgs(): string
      • +
    +
      +
    • + +
      +
      +

      Set scriptArgs. Also you should set checking interval

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tcp

    -
    tcp: string
    - -
    -
    -

    Set TCP address to check. Also you should set checking interval

    -
    -
    -
    param
    -

    TCP address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getServiceId

    +
      +
    • getServiceId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the service ID to associate the registered check with an existing service provided by the agent.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    ttl

    -
    ttl: string
    - -
    -
    -

    Set Time to Live of check.

    -
    -
    -
    param
    -

    Time to Live of check

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getStatus

    +
      +
    • getStatus(): CheckStatus
      • +
    +
      +
    • + +
      +
      +

      Set the check status to specify the initial state of the health check.

      +
      +
      +

      Returns CheckStatus

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTcp

    +
      +
    • getTcp(): string
      • +
    +
      +
    • + +
      +
      +

      Set TCP address to check. Also you should set checking interval

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTtl

    +
      +
    • getTtl(): string
      • +
    +
      +
    • + +
      +
      +

      Set Time to Live of check.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    isGrpcTls

    +
      +
    • isGrpcTls(): boolean
      • +
    +
      +
    • + +
      +
      +

      Specifies whether to use TLS for this gRPC health check. + If TLS is enabled, then by default, a valid TLS certificate is expected. + Certificate verification can be turned off by setting {@code TLSSkipVerify} to {@code true}.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTlsSkipVerify

    +
      +
    • isTlsSkipVerify(): boolean
      • +
    +
      +
    • + +
      +
      +

      Specifies if the certificate for an HTTPS check should not be verified.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    setDeregisterAfter

    +
      +
    • setDeregisterAfter(deregisterAfter: string): CheckOptions
      • +
    +
      +
    • + +
      +
      +

      Set deregister timeout. This is optional field, which is a timeout in the same time format as Interval and TTL. + If a check is associated with a service and has the critical state for more than this configured value, + then its associated service (and all of its associated checks) will automatically be deregistered. + The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, + so it may take slightly longer than the configured timeout to trigger the deregistration. + This should generally be configured with a timeout that's much, much longer than any expected recoverable outage + for the given service.

      +
      +
      +

      Parameters

      +
        +
      • +
        deregisterAfter: string
        +
        +

        timeout

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setGrpc

    + +
      +
    • + +
      +
      +

      Specifies a gRPC check's endpoint that supports the standard + gRPC health checking protocol. + The state of the check will be updated at the given Interval by probing the configured endpoint. + The endpoint must be represented as {@code address:port/service}

      +
      +
      +

      Parameters

      +
        +
      • +
        grpc: string
        +
        +

        endpoint

        +
        +
        • +
      +

      Returns CheckOptions

      +
      • +
    +
    +
    + +

    setGrpcTls

    + +
      +
    • + +
      +
      +

      Specifies whether to use TLS for this gRPC health check. + If TLS is enabled, then by default, a valid TLS certificate is expected. + Certificate verification can be turned off by setting {@code TLSSkipVerify} to {@code true}.

      +
      +
      +

      Parameters

      +
        +
      • +
        grpcTls: boolean
        +
        +

        true if TLS is enabled

        +
        +
        • +
      +

      Returns CheckOptions

      +
      • +
    +
    +
    + +

    setHttp

    + +
      +
    • + +
      +
      +

      Set HTTP address to check. Also you should set checking interval

      +
      +
      +

      Parameters

      +
        +
      • +
        http: string
        +
        +

        HTTP address

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set check ID

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        check ID

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setInterval

    + +
      +
    • + +
      +
      +

      Set checking interval

      +
      +
      +

      Parameters

      +
        +
      • +
        interval: string
        +
        +

        checking interval in Go's time format which is sequence of decimal numbers, + each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". + Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h"

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Set check name. This is mandatory field

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        check name

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNotes

    + +
      +
    • + +
      +
      +

      Set check notes

      +
      +
      +

      Parameters

      +
        +
      • +
        notes: string
        +
        +

        check notes

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setScriptArgs

    + +
      +
    • + +
      +
      +

      Set scriptArgs. Also you should set checking interval

      +
      +
      +

      Parameters

      +
        +
      • +
        scriptArgs: string
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setServiceId

    + +
      +
    • + +
      +
      +

      Set the service ID to associate the registered check with an existing service provided by the agent.

      +
      +
      +

      Parameters

      +
        +
      • +
        serviceId: string
        +
        +

        the service ID

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setStatus

    + +
      +
    • + +
      +
      +

      Set the check status to specify the initial state of the health check.

      +
      +
      +

      Parameters

      +
        +
      • +
        status: CheckStatus
        +
        +

        the check status

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTcp

    + +
      +
    • + +
      +
      +

      Set TCP address to check. Also you should set checking interval

      +
      +
      +

      Parameters

      +
        +
      • +
        tcp: string
        +
        +

        TCP address

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTlsSkipVerify

    +
      +
    • setTlsSkipVerify(tlsSkipVerify: boolean): CheckOptions
      • +
    +
      +
    • + +
      +
      +

      Specifies if the certificate for an HTTPS check should not be verified.

      +
      +
      +

      Parameters

      +
        +
      • +
        tlsSkipVerify: boolean
        +
        +

        true if the certificate for an HTTPS check should not be verified.

        +
        +
        • +
      +

      Returns CheckOptions

      +
      • +
    +
    +
    + +

    setTtl

    + +
      +
    • + +
      +
      +

      Set Time to Live of check.

      +
      +
      +

      Parameters

      +
        +
      • +
        ttl: string
        +
        +

        Time to Live of check

        +
        +
        • +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -387,38 +969,92 @@

    ttl

  • CheckOptions
    • @@ -523,10 +1159,10 @@

    ttl

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/checkqueryoptions.html b/docs/@vertx/consul-client/classes/checkqueryoptions.html index 351e06da2..078108d65 100644 --- a/docs/@vertx/consul-client/classes/checkqueryoptions.html +++ b/docs/@vertx/consul-client/classes/checkqueryoptions.html @@ -77,62 +77,166 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    blockingOptions

    -
    blockingOptions: BlockingQueryOptions
    - -
    -
    -

    Set options for blocking query

    -
    -
    -
    param
    -

    the blocking options

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    near

    -
    near: string
    - -
    -
    -

    Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

    -
    -
    -
    param
    -

    the node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Returns BlockingQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getNear

    +
      +
    • getNear(): string
      • +
    +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Parameters

      + +

      Returns CheckQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNear

    + +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

      +
      +
      +

      Parameters

      +
        +
      • +
        near: string
        +
        +

        the node name

        +
        +
        • +
      +

      Returns CheckQueryOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -166,11 +270,20 @@

    near

  • CheckQueryOptions
    • @@ -272,10 +385,10 @@

    near

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/consulclient.html b/docs/@vertx/consul-client/classes/consulclient.html index e2a901768..ae0187b41 100644 --- a/docs/@vertx/consul-client/classes/consulclient.html +++ b/docs/@vertx/consul-client/classes/consulclient.html @@ -172,12 +172,12 @@

    agentInfo

  • -

    Returns the configuration and member information of the local agent

    +

    Returns the configuration and member information of the local agent

    see
    @@ -195,17 +195,20 @@
    resultHandler: function
      • -
      • (result: AsyncResult<any>): void
        • +
      • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

      • Parameters

        • -
          result: AsyncResult<any>
          +
          res: AsyncResult<object>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<object>> +

      • @@ -227,12 +230,12 @@

      catalogDatacenters

    • -

      Return all the datacenters that are known by the Consul server

      +

      Return all the datacenters that are known by the Consul server

      see
      @@ -250,17 +253,20 @@
      resultHandler: function
        • -
        • (result: AsyncResult<string[]>): void
          • +
        • (res: AsyncResult<string[]>): void | Handler<AsyncResult<string[]>>

        • Parameters

          • -
            result: AsyncResult<string[]>
            +
            res: AsyncResult<string[]>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<string[]>> +

        • @@ -282,12 +288,12 @@

        catalogNodeServices

      • -

        Returns the node's registered services

        +

        Returns the node's registered services

        see
        @@ -311,17 +317,20 @@
        resultHandler: function
          • @@ -343,12 +352,12 @@

          catalogNodeServicesWithOptions

        • -

          Returns the node's registered services +

          Returns the node's registered services This is blocking query unlike {@link ConsulClient#catalogNodeServices(String, Handler)}

          @@ -379,17 +388,20 @@
          resultHandler: function
            • @@ -411,12 +423,12 @@

            catalogNodes

          • -

            Returns the nodes registered in a datacenter

            +

            Returns the nodes registered in a datacenter

            see
            @@ -434,17 +446,20 @@
            resultHandler: function

              • Parameters

                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<NodeList>> +

              • @@ -466,12 +481,12 @@

              catalogNodesWithOptions

            • -

              Returns the nodes registered in a datacenter

              +

              Returns the nodes registered in a datacenter

              see
              @@ -495,17 +510,20 @@
              resultHandler: function

                • Parameters

                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<NodeList>> +

                • @@ -527,12 +545,12 @@

                catalogServiceNodes

              • -

                Returns the nodes providing a service

                +

                Returns the nodes providing a service

                see
                @@ -556,17 +574,20 @@
                resultHandler: function
                  • @@ -588,12 +609,12 @@

                  catalogServiceNodesWithOptions

                • -

                  Returns the nodes providing a service

                  +

                  Returns the nodes providing a service

                  see
                  @@ -623,17 +644,20 @@
                  resultHandler: function
                    • @@ -655,12 +679,12 @@

                    catalogServices

                  • -

                    Returns the services registered in a datacenter

                    +

                    Returns the services registered in a datacenter

                    see
                    @@ -678,17 +702,20 @@
                    resultHandler: function
                      • @@ -710,12 +737,12 @@

                      catalogServicesWithOptions

                    • -

                      Returns the services registered in a datacenter +

                      Returns the services registered in a datacenter This is blocking query unlike {@link ConsulClient#catalogServices(Handler)}

                      @@ -740,17 +767,20 @@
                      resultHandler: function
                        • @@ -772,12 +802,12 @@

                        cloneAclToken

                      • -

                        Clone Acl token

                        +

                        Clone Acl token

                        see
                        @@ -801,17 +831,20 @@
                        idHandler: function
                          • -
                          • (result: AsyncResult<string>): void
                            • +
                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                          • Parameters

                            • -
                              result: AsyncResult<string>
                              +
                              res: AsyncResult<string>
                            -

                            Returns void

                            +

                            Returns void + | + Handler<AsyncResult<string>> +

                          • @@ -833,12 +866,12 @@

                          close

                        • -

                          Close the client and release its resources

                          +

                          Close the client and release its resources

                          Returns void

                          @@ -855,12 +888,12 @@

                          coordinateDatacenters

                        • -

                          Returns the WAN network coordinates for all Consul servers, organized by DCs

                          +

                          Returns the WAN network coordinates for all Consul servers, organized by DCs

                          see
                          @@ -878,17 +911,20 @@
                          resultHandler: function
                            • @@ -910,12 +946,12 @@

                            coordinateNodes

                          • -

                            Returns the LAN network coordinates for all nodes in a given DC

                            +

                            Returns the LAN network coordinates for all nodes in a given DC

                            see
                            @@ -933,17 +969,20 @@
                            resultHandler: function
                              • @@ -965,12 +1004,12 @@

                              coordinateNodesWithOptions

                            • -

                              Returns the LAN network coordinates for all nodes in a given DC +

                              Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike {@link ConsulClient#coordinateNodes(Handler)}

                              @@ -995,17 +1034,20 @@
                              resultHandler: function
                                • @@ -1027,12 +1069,12 @@

                                createAclToken

                              • -

                                Create new Acl token

                                +

                                Create new Acl token

                                see
                                @@ -1056,17 +1098,20 @@
                                idHandler: function
                                  • -
                                  • (result: AsyncResult<string>): void
                                    • +
                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                  • Parameters

                                    • -
                                      result: AsyncResult<string>
                                      +
                                      res: AsyncResult<string>
                                    -

                                    Returns void

                                    +

                                    Returns void + | + Handler<AsyncResult<string>> +

                                  • @@ -1088,7 +1133,7 @@

                                  createPreparedQuery

                                • @@ -1114,17 +1159,20 @@
                                  resultHandler: function
                                    • -
                                    • (result: AsyncResult<string>): void
                                      • +
                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                    • Parameters

                                      • -
                                        result: AsyncResult<string>
                                        +
                                        res: AsyncResult<string>
                                      -

                                      Returns void

                                      +

                                      Returns void + | + Handler<AsyncResult<string>> +

                                    • @@ -1146,12 +1194,12 @@

                                    createSession

                                  • -

                                    Initialize a new session

                                    +

                                    Initialize a new session

                                    see
                                    @@ -1169,17 +1217,20 @@
                                    idHandler: function
                                      • -
                                      • (result: AsyncResult<string>): void
                                        • +
                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                      • Parameters

                                        • -
                                          result: AsyncResult<string>
                                          +
                                          res: AsyncResult<string>
                                        -

                                        Returns void

                                        +

                                        Returns void + | + Handler<AsyncResult<string>> +

                                      • @@ -1201,12 +1252,12 @@

                                      createSessionWithOptions

                                    • -

                                      Initialize a new session

                                      +

                                      Initialize a new session

                                      see
                                      @@ -1230,17 +1281,20 @@
                                      idHandler: function
                                        • -
                                        • (result: AsyncResult<string>): void
                                          • +
                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                        • Parameters

                                          • -
                                            result: AsyncResult<string>
                                            +
                                            res: AsyncResult<string>
                                          -

                                          Returns void

                                          +

                                          Returns void + | + Handler<AsyncResult<string>> +

                                        • @@ -1262,12 +1316,12 @@

                                        deletePreparedQuery

                                      • -

                                        Deletes an existing prepared query

                                        +

                                        Deletes an existing prepared query

                                        see
                                        @@ -1291,17 +1345,20 @@
                                        resultHandler: function
                                          • -
                                          • (result: AsyncResult<void>): void
                                            • +
                                          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                          • Parameters

                                            • -
                                              result: AsyncResult<void>
                                              +
                                              res: AsyncResult<void>
                                            -

                                            Returns void

                                            +

                                            Returns void + | + Handler<AsyncResult<void>> +

                                          • @@ -1323,12 +1380,12 @@

                                          deleteValue

                                        • -

                                          Remove the key/value pair that corresponding to the specified key

                                          +

                                          Remove the key/value pair that corresponding to the specified key

                                          see
                                          @@ -1352,17 +1409,20 @@
                                          resultHandler: function
                                            • -
                                            • (result: AsyncResult<void>): void
                                              • +
                                            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                            • Parameters

                                              • -
                                                result: AsyncResult<void>
                                                +
                                                res: AsyncResult<void>
                                              -

                                              Returns void

                                              +

                                              Returns void + | + Handler<AsyncResult<void>> +

                                            • @@ -1384,12 +1444,12 @@

                                            deleteValues

                                          • -

                                            Removes all the key/value pair that corresponding to the specified key prefix

                                            +

                                            Removes all the key/value pair that corresponding to the specified key prefix

                                            see
                                            @@ -1413,17 +1473,20 @@
                                            resultHandler: function
                                              • -
                                              • (result: AsyncResult<void>): void
                                                • +
                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                              • Parameters

                                                • -
                                                  result: AsyncResult<void>
                                                  +
                                                  res: AsyncResult<void>
                                                -

                                                Returns void

                                                +

                                                Returns void + | + Handler<AsyncResult<void>> +

                                              • @@ -1445,12 +1508,12 @@

                                              deregisterCheck

                                            • -

                                              Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.

                                              +

                                              Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.

                                              see
                                              @@ -1474,17 +1537,20 @@
                                              resultHandler: function
                                                • -
                                                • (result: AsyncResult<void>): void
                                                  • +
                                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                • Parameters

                                                  • -
                                                    result: AsyncResult<void>
                                                    +
                                                    res: AsyncResult<void>
                                                  -

                                                  Returns void

                                                  +

                                                  Returns void + | + Handler<AsyncResult<void>> +

                                                • @@ -1506,12 +1572,12 @@

                                                deregisterService

                                              • -

                                                Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. +

                                                Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.

                                                @@ -1536,17 +1602,20 @@
                                                resultHandler: function
                                                  • -
                                                  • (result: AsyncResult<void>): void
                                                    • +
                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                  • Parameters

                                                    • -
                                                      result: AsyncResult<void>
                                                      +
                                                      res: AsyncResult<void>
                                                    -

                                                    Returns void

                                                    +

                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                  • @@ -1568,12 +1637,12 @@

                                                  destroyAclToken

                                                • -

                                                  Destroy Acl token

                                                  +

                                                  Destroy Acl token

                                                  see
                                                  @@ -1597,17 +1666,20 @@
                                                  resultHandler: function
                                                    • -
                                                    • (result: AsyncResult<void>): void
                                                      • +
                                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                    • Parameters

                                                      • -
                                                        result: AsyncResult<void>
                                                        +
                                                        res: AsyncResult<void>
                                                      -

                                                      Returns void

                                                      +

                                                      Returns void + | + Handler<AsyncResult<void>> +

                                                    • @@ -1629,12 +1701,12 @@

                                                    destroySession

                                                  • -

                                                    Destroys the given session

                                                    +

                                                    Destroys the given session

                                                    see
                                                    @@ -1658,17 +1730,20 @@
                                                    resultHandler: function
                                                      • -
                                                      • (result: AsyncResult<void>): void
                                                        • +
                                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                      • Parameters

                                                        • -
                                                          result: AsyncResult<void>
                                                          +
                                                          res: AsyncResult<void>
                                                        -

                                                        Returns void

                                                        +

                                                        Returns void + | + Handler<AsyncResult<void>> +

                                                      • @@ -1690,12 +1765,12 @@

                                                      executePreparedQuery

                                                    • -

                                                      Executes an existing prepared query.

                                                      +

                                                      Executes an existing prepared query.

                                                      see
                                                      @@ -1720,17 +1795,20 @@
                                                      resultHandler: function
                                                        • @@ -1752,12 +1830,12 @@

                                                        executePreparedQueryWithOptions

                                                      • -

                                                        Executes an existing prepared query.

                                                        +

                                                        Executes an existing prepared query.

                                                        see
                                                        @@ -1788,17 +1866,20 @@
                                                        resultHandler: function
                                                          • @@ -1820,12 +1901,12 @@

                                                          failCheck

                                                        • -

                                                          Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

                                                          +

                                                          Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

                                                          see
                                                          @@ -1852,17 +1933,20 @@
                                                          resultHandler: function
                                                            • -
                                                            • (result: AsyncResult<void>): void
                                                              • +
                                                            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                            • Parameters

                                                              • -
                                                                result: AsyncResult<void>
                                                                +
                                                                res: AsyncResult<void>
                                                              -

                                                              Returns void

                                                              +

                                                              Returns void + | + Handler<AsyncResult<void>> +

                                                            • @@ -1884,12 +1968,12 @@

                                                            failCheckWithNote

                                                          • -

                                                            Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

                                                            +

                                                            Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

                                                            see
                                                            @@ -1911,7 +1995,7 @@
                                                            checkId: string
                                                          • note: string
                                                            -

                                                            a human-readable message with the status of the check

                                                            +

                                                            specifies a human-readable message. This will be passed through to the check's {@code Output} field.

                                                          • @@ -1922,17 +2006,20 @@
                                                            resultHandler: function
                                                              • -
                                                              • (result: AsyncResult<void>): void
                                                                • +
                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                              • Parameters

                                                                • -
                                                                  result: AsyncResult<void>
                                                                  +
                                                                  res: AsyncResult<void>
                                                                -

                                                                Returns void

                                                                +

                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                              • @@ -1954,12 +2041,12 @@

                                                              fireEvent

                                                            • -

                                                              Fires a new user event

                                                              +

                                                              Fires a new user event

                                                              see
                                                              @@ -1983,17 +2070,20 @@
                                                              resultHandler: function
                                                                • -
                                                                • (result: AsyncResult<Event>): void
                                                                  • +
                                                                • (res: AsyncResult<Event>): void | Handler<AsyncResult<Event>>

                                                                • Parameters

                                                                  • -
                                                                    result: AsyncResult<Event>
                                                                    +
                                                                    res: AsyncResult<Event>
                                                                  -

                                                                  Returns void

                                                                  +

                                                                  Returns void + | + Handler<AsyncResult<Event>> +

                                                                • @@ -2015,12 +2105,12 @@

                                                                fireEventWithOptions

                                                              • -

                                                                Fires a new user event

                                                                +

                                                                Fires a new user event

                                                                see
                                                                @@ -2050,17 +2140,20 @@
                                                                resultHandler: function
                                                                  • -
                                                                  • (result: AsyncResult<Event>): void
                                                                    • +
                                                                  • (res: AsyncResult<Event>): void | Handler<AsyncResult<Event>>

                                                                  • Parameters

                                                                    • -
                                                                      result: AsyncResult<Event>
                                                                      +
                                                                      res: AsyncResult<Event>
                                                                    -

                                                                    Returns void

                                                                    +

                                                                    Returns void + | + Handler<AsyncResult<Event>> +

                                                                  • @@ -2082,12 +2175,12 @@

                                                                  getAllPreparedQueries

                                                                • -

                                                                  Returns a list of all prepared queries.

                                                                  +

                                                                  Returns a list of all prepared queries.

                                                                  see
                                                                  @@ -2105,17 +2198,20 @@
                                                                  resultHandler: function
                                                                    • @@ -2137,12 +2233,12 @@

                                                                    getKeys

                                                                  • -

                                                                    Returns the list of keys that corresponding to the specified key prefix.

                                                                    +

                                                                    Returns the list of keys that corresponding to the specified key prefix.

                                                                    see
                                                                    @@ -2166,17 +2262,20 @@
                                                                    resultHandler: function
                                                                      • -
                                                                      • (result: AsyncResult<string[]>): void
                                                                        • +
                                                                      • (res: AsyncResult<string[]>): void | Handler<AsyncResult<string[]>>

                                                                      • Parameters

                                                                        • -
                                                                          result: AsyncResult<string[]>
                                                                          +
                                                                          res: AsyncResult<string[]>
                                                                        -

                                                                        Returns void

                                                                        +

                                                                        Returns void + | + Handler<AsyncResult<string[]>> +

                                                                      • @@ -2198,12 +2297,12 @@

                                                                      getKeysWithOptions

                                                                    • -

                                                                      Returns the list of keys that corresponding to the specified key prefix.

                                                                      +

                                                                      Returns the list of keys that corresponding to the specified key prefix.

                                                                      see
                                                                      @@ -2233,17 +2332,20 @@
                                                                      resultHandler: function
                                                                        • -
                                                                        • (result: AsyncResult<string[]>): void
                                                                          • +
                                                                        • (res: AsyncResult<string[]>): void | Handler<AsyncResult<string[]>>

                                                                        • Parameters

                                                                          • -
                                                                            result: AsyncResult<string[]>
                                                                            +
                                                                            res: AsyncResult<string[]>
                                                                          -

                                                                          Returns void

                                                                          +

                                                                          Returns void + | + Handler<AsyncResult<string[]>> +

                                                                        • @@ -2265,12 +2367,12 @@

                                                                        getPreparedQuery

                                                                      • -

                                                                        Returns an existing prepared query

                                                                        +

                                                                        Returns an existing prepared query

                                                                        see
                                                                        @@ -2294,17 +2396,20 @@
                                                                        resultHandler: function
                                                                          • @@ -2326,12 +2431,12 @@

                                                                          getValue

                                                                        • -

                                                                          Returns key/value pair that corresponding to the specified key. +

                                                                          Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.

                                                                          @@ -2356,17 +2461,20 @@
                                                                          resultHandler: function

                                                                            • Parameters

                                                                              -

                                                                              Returns void

                                                                              +

                                                                              Returns void + | + Handler<AsyncResult<KeyValue>> +

                                                                            • @@ -2388,12 +2496,12 @@

                                                                            getValueWithOptions

                                                                          • -

                                                                            Returns key/value pair that corresponding to the specified key. +

                                                                            Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike {@link ConsulClient#getValue(String, Handler)}

                                                                            @@ -2425,17 +2533,20 @@
                                                                            resultHandler: function

                                                                              • Parameters

                                                                                -

                                                                                Returns void

                                                                                +

                                                                                Returns void + | + Handler<AsyncResult<KeyValue>> +

                                                                              • @@ -2457,12 +2568,12 @@

                                                                              getValues

                                                                            • -

                                                                              Returns the list of key/value pairs that corresponding to the specified key prefix. +

                                                                              Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.

                                                                              @@ -2487,17 +2598,20 @@
                                                                              resultHandler: function
                                                                                • @@ -2519,12 +2633,12 @@

                                                                                getValuesWithOptions

                                                                              • -

                                                                                Returns the list of key/value pairs that corresponding to the specified key prefix. +

                                                                                Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike {@link ConsulClient#getValues(String, Handler)}

                                                                                @@ -2556,17 +2670,20 @@
                                                                                resultHandler: function
                                                                                  • @@ -2588,12 +2705,12 @@

                                                                                  healthChecks

                                                                                • -

                                                                                  Returns the checks associated with the service

                                                                                  +

                                                                                  Returns the checks associated with the service

                                                                                  see
                                                                                  @@ -2617,17 +2734,20 @@
                                                                                  resultHandler: function

                                                                                    • Parameters

                                                                                      -

                                                                                      Returns void

                                                                                      +

                                                                                      Returns void + | + Handler<AsyncResult<CheckList>> +

                                                                                    • @@ -2649,12 +2769,12 @@

                                                                                    healthChecksWithOptions

                                                                                  • -

                                                                                    Returns the checks associated with the service

                                                                                    +

                                                                                    Returns the checks associated with the service

                                                                                    see
                                                                                    @@ -2684,17 +2804,20 @@
                                                                                    resultHandler: function

                                                                                      • Parameters

                                                                                        -

                                                                                        Returns void

                                                                                        +

                                                                                        Returns void + | + Handler<AsyncResult<CheckList>> +

                                                                                      • @@ -2716,12 +2839,12 @@

                                                                                      healthServiceNodes

                                                                                    • -

                                                                                      Returns the nodes providing the service. This endpoint is very similar to the {@link ConsulClient#catalogServiceNodes} endpoint; +

                                                                                      Returns the nodes providing the service. This endpoint is very similar to the {@link ConsulClient#catalogServiceNodes} endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

                                                                                      @@ -2752,17 +2875,20 @@
                                                                                      resultHandler: function
    • -

    Properties

    -
    - -

    aclToken

    -
    aclToken: string
    - -
    -
    -

    Set the ACL token. When provided, the client will use this token when making requests to the Consul - by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' - ACL policy, is used.

    -
    -
    -
    param
    -

    the ACL token

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    alpnVersions

    -
    alpnVersions: HttpVersion
    - -
    -
    -

    Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. - When the list is empty, the client provides a best effort list according to {@link #setProtocolVersion}:

    -
    -
      -
    • {@link HttpVersion#HTTP_2}: [ "h2", "http/1.1" ]
      • -
    • otherwise: [{@link #getProtocolVersion()}]
      • -
    -
    -
    param
    -

    the versions

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - -
    -
    -

    Set the connect timeout

    -
    -
    -
    param
    -

    connect timeout, in ms

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - -
    -
    -

    Add a CRL path

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - -
    -
    -

    Add a CRL value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): ConsulClientOptions
      • +
    +
      +
    • + +
      +
      +

      Add an enabled SSL/TLS protocols, appended to the ordered protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    dc

    -
    dc: string
    - -
    -
    -

    Set the datacenter name. When provided, the client will use it when making requests to the Consul - by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried.

    -
    -
    -
    param
    -

    the datacenter name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getAclToken

    +
      +
    • getAclToken(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ACL token. When provided, the client will use this token when making requests to the Consul + by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' + ACL policy, is used.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    decoderInitialBufferSize

    -
    decoderInitialBufferSize: number
    - -
    -
    -

    set to {@code initialBufferSizeHttpDecoder} the initial buffer of the HttpDecoder.

    -
    -
    -
    param
    -

    the initial buffer size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getAlpnVersions

    +
      +
    • getAlpnVersions(): HttpVersion
      • +
    +
      +
    • + +
      +
      +

      Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. + When the list is empty, the client provides a best effort list according to {@link #setProtocolVersion}:

      +
      +
        +
      • {@link HttpVersion#HTTP_2}: [ "h2", "http/1.1" ]
        • +
      • otherwise: [{@link #getProtocolVersion()}]
        • +
      +
      +

      Returns HttpVersion

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    defaultHost

    -
    defaultHost: string
    - -
    -
    -

    Set the default host name to be used by this client in requests if none is provided when making the request.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the connect timeout

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    defaultPort

    -
    defaultPort: number
    - -
    -
    -

    Set the default port to be used by this client in requests if none is provided when making the request.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - -
    -
    -

    Add an enabled cipher suite, appended to the ordered suites.

    -
    -
    -
    param
    -

    the suite

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - -
    -
    -

    Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    -
    -
    -
    param
    -

    the SSL/TLS protocol do enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDc

    +
      +
    • getDc(): string
      • +
    +
      +
    • + +
      +
      +

      Set the datacenter name. When provided, the client will use it when making requests to the Consul + by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    followRedirects

    -
    followRedirects: boolean
    - -
    -
    -

    Configure the default behavior of the client to follow HTTP {@code 30x} redirections.

    -
    -
    -
    param
    -

    true when a redirect is followed

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDecoderInitialBufferSize

    +
      +
    • getDecoderInitialBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      set to {@code initialBufferSizeHttpDecoder} the initial buffer of the HttpDecoder.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    forceSni

    -
    forceSni: boolean
    - -
    -
    -

    By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting - this property to {@code true} forces the server name to be always sent.

    -
    -
    -
    param
    -

    true when the client should always use SNI on TLS/SSL connections

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDefaultHost

    +
      +
    • getDefaultHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the default host name to be used by this client in requests if none is provided when making the request.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    http2ClearTextUpgrade

    -
    http2ClearTextUpgrade: boolean
    - -
    -
    -

    Set to {@code true} when an h2c connection is established using an HTTP/1.1 upgrade request, and {@code false} - when an h2c connection is established directly (with prior knowledge).

    -
    -
    -
    param
    -

    the upgrade value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDefaultPort

    +
      +
    • getDefaultPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the default port to be used by this client in requests if none is provided when making the request.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    http2ConnectionWindowSize

    -
    http2ConnectionWindowSize: number
    - -
    -
    -

    Set the default HTTP/2 connection window size. It overrides the initial window - size set by {@link Http2Settings#getInitialWindowSize}, so the connection window size - is greater than for its streams, in order the data throughput. -

    - A value of {@code -1} reuses the initial window size setting.

    -
    -
    -
    param
    -

    the window size applied to the connection

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    http2KeepAliveTimeout

    -
    http2KeepAliveTimeout: number
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +
      +
      +

      Add an enabled SSL/TLS protocols, appended to the ordered protocols.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    http2MaxPoolSize

    -
    http2MaxPoolSize: number
    - -
    -
    -

    Set the maximum pool size for HTTP/2 connections

    -
    -
    -
    param
    -

    the maximum pool size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHttp2ConnectionWindowSize

    +
      +
    • getHttp2ConnectionWindowSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the default HTTP/2 connection window size. It overrides the initial window + size set by {@link Http2Settings#getInitialWindowSize}, so the connection window size + is greater than for its streams, in order the data throughput. +

      + A value of {@code -1} reuses the initial window size setting.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    http2MultiplexingLimit

    -
    http2MultiplexingLimit: number
    - -
    -
    -

    Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number - of streams the client can create for a connection. The effective number of streams for a - connection is the min of this value and the server's initial settings. -

    - Setting the value to {@code -1} means to use the value sent by the server's initial settings. - {@code -1} is the default value.

    -
    -
    -
    param
    -

    the maximum concurrent for an HTTP/2 connection

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHttp2KeepAliveTimeout

    +
      +
    • getHttp2KeepAliveTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - -
    -
    -

    Set the idle timeout, in seconds. zero means don't timeout. - This determines if a connection will timeout and be closed if no data is received within the timeout.

    -
    -
    -
    param
    -

    the timeout, in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHttp2MaxPoolSize

    +
      +
    • getHttp2MaxPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum pool size for HTTP/2 connections

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    initialSettings

    -
    initialSettings: Http2Settings
    - -
    -
    -

    Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

    -
    -
    -
    param
    -

    the settings value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHttp2MultiplexingLimit

    +
      +
    • getHttp2MultiplexingLimit(): number
      • +
    +
      +
    • + +
      +
      +

      Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number + of streams the client can create for a connection. The effective number of streams for a + connection is the min of this value and the server's initial settings. +

      + Setting the value to {@code -1} means to use the value sent by the server's initial settings. + {@code -1} is the default value.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout, in seconds. zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keepAlive

    -
    keepAlive: boolean
    - -
    -
    -

    Set whether keep alive is enabled on the client

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keepAliveTimeout

    -
    keepAliveTimeout: number
    - +
    + +

    getInitialSettings

    +
      +
    • getInitialSettings(): Http2Settings
      • +
    +
      +
    • + +
      +
      +

      Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

      +
      +
      +

      Returns Http2Settings

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - -
    -
    -

    Set the key/cert options in jks format, aka Java keystore.

    -
    -
    -
    param
    -

    the key store in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - -
    -
    -

    Set the local interface to bind for network connections. When the local address is null, - it will pick any local address, the default local address is null.

    -
    -
    -
    param
    -

    the local address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getKeepAliveTimeout

    +
      +
    • getKeepAliveTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - -
    -
    -

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    -
    -
    -
    param
    -

    true for logging the network activity

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxChunkSize

    -
    maxChunkSize: number
    - -
    -
    -

    Set the maximum HTTP chunk size

    -
    -
    -
    param
    -

    the maximum chunk size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set the local interface to bind for network connections. When the local address is null, + it will pick any local address, the default local address is null.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxHeaderSize

    -
    maxHeaderSize: number
    - -
    -
    -

    Set the maximum length of all headers for HTTP/1.x .

    -
    -
    -
    param
    -

    the new maximum length

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxInitialLineLength

    -
    maxInitialLineLength: number
    - -
    -
    -

    Set the maximum length of the initial line for HTTP/1.x (e.g. {@code "HTTP/1.1 200 OK"})

    -
    -
    -
    param
    -

    the new maximum initial length

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxChunkSize

    +
      +
    • getMaxChunkSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum HTTP chunk size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxPoolSize

    -
    maxPoolSize: number
    - -
    -
    -

    Set the maximum pool size for connections

    -
    -
    -
    param
    -

    the maximum pool size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxHeaderSize

    +
      +
    • getMaxHeaderSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum length of all headers for HTTP/1.x .

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxRedirects

    -
    maxRedirects: number
    - -
    -
    -

    Set to {@code maxRedirects} the maximum number of redirection a request can follow.

    -
    -
    -
    param
    -

    the maximum number of redirection

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxInitialLineLength

    +
      +
    • getMaxInitialLineLength(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum length of the initial line for HTTP/1.x (e.g. {@code "HTTP/1.1 200 OK"})

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWaitQueueSize

    -
    maxWaitQueueSize: number
    - -
    -
    -

    Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in - a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

    -
    -
    -
    param
    -

    the maximum number of waiting requests

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxPoolSize

    +
      +
    • getMaxPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum pool size for connections

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMaxRedirects

    +
      +
    • getMaxRedirects(): number
      • +
    +
      +
    • + +
      +
      +

      Set to {@code maxRedirects} the maximum number of redirection a request can follow.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMaxWaitQueueSize

    +
      +
    • getMaxWaitQueueSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in + a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMaxWebsocketFrameSize

    +
      +
    • getMaxWebsocketFrameSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the max websocket frame size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMaxWebsocketMessageSize

    +
      +
    • getMaxWebsocketMessageSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the max websocket message size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the metrics name identifying the reported metrics, useful for grouping metrics + with the same name.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +
      +
      +

      Set the trust options.

      +
      +
      +

      Returns PemTrustOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPipeliningLimit

    +
      +
    • getPipeliningLimit(): number
      • +
    +
      +
    • + +
      +
      +

      Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPoolCleanerPeriod

    +
      +
    • getPoolCleanerPeriod(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getProtocolVersion

    +
      +
    • getProtocolVersion(): HttpVersion
      • +
    +
      +
    • + +
      +
      +

      Set the protocol version.

      +
      +
      +

      Returns HttpVersion

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +
      +
      +

      Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

      +
      +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTimeout

    +
      +
    • getTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the amount of time (in milliseconds) after which if the request does not return any data + within the timeout period an failure will be passed to the handler and the request will be closed.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getUserAgent

    +
      +
    • getUserAgent(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWebsocketCompressionAllowClientNoContext

    +
      +
    • getWebsocketCompressionAllowClientNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getWebsocketCompressionLevel

    +
      +
    • getWebsocketCompressionLevel(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getWebsocketCompressionRequestServerNoContext

    +
      +
    • getWebsocketCompressionRequestServerNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isFollowRedirects

    +
      +
    • isFollowRedirects(): boolean
      • +
    +
      +
    • + +
      +
      +

      Configure the default behavior of the client to follow HTTP {@code 30x} redirections.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isForceSni

    +
      +
    • isForceSni(): boolean
      • +
    +
      +
    • + +
      +
      +

      By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting + this property to {@code true} forces the server name to be always sent.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isHttp2ClearTextUpgrade

    +
      +
    • isHttp2ClearTextUpgrade(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to {@code true} when an h2c connection is established using an HTTP/1.1 upgrade request, and {@code false} + when an h2c connection is established directly (with prior knowledge).

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isKeepAlive

    +
      +
    • isKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether keep alive is enabled on the client

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isPipelining

    +
      +
    • isPipelining(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether pipe-lining is enabled on the client

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSendUnmaskedFrames

    +
      +
    • isSendUnmaskedFrames(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set true when the client wants to skip frame masking. + You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. + It's false as default.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Returns boolean

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether all server certificates should be trusted

      +
      +
      +

      Returns boolean

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    isTryUseCompression

    +
      +
    • isTryUseCompression(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether compression is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isUserAgentEnabled

    +
      +
    • isUserAgentEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether the Web Client should send a user agent header. Defaults to true.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isVerifyHost

    +
      +
    • isVerifyHost(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether hostname verification is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAclToken

    + +
      +
    • + +
      +
      +

      Set the ACL token. When provided, the client will use this token when making requests to the Consul + by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' + ACL policy, is used.

      +
      +
      +

      Parameters

      +
        +
      • +
        aclToken: string
        +
        +

        the ACL token

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setAlpnVersions

    + +
      +
    • + +
      +
      +

      Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. + When the list is empty, the client provides a best effort list according to {@link #setProtocolVersion}:

      +
      +
        +
      • {@link HttpVersion#HTTP_2}: [ "h2", "http/1.1" ]
        • +
      • otherwise: [{@link #getProtocolVersion()}]
        • +
      +
      +

      Parameters

      +
        +
      • +
        alpnVersions: HttpVersion
        +
        +

        the versions

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +
      +
      +

      Set the connect timeout

      +
      +
      +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        +

        connect timeout, in ms

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDc

    + +
      +
    • + +
      +
      +

      Set the datacenter name. When provided, the client will use it when making requests to the Consul + by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried.

      +
      +
      +

      Parameters

      +
        +
      • +
        dc: string
        +
        +

        the datacenter name

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setDecoderInitialBufferSize

    + +
      +
    • + +
      +
      +

      set to {@code initialBufferSizeHttpDecoder} the initial buffer of the HttpDecoder.

      +
      +
      +

      Parameters

      +
        +
      • +
        decoderInitialBufferSize: number
        +
        +

        the initial buffer size

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDefaultHost

    + +
      +
    • + +
      +
      +

      Set the default host name to be used by this client in requests if none is provided when making the request.

      +
      +
      +

      Parameters

      +
        +
      • +
        defaultHost: string
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDefaultPort

    + +
      +
    • + +
      +
      +

      Set the default port to be used by this client in requests if none is provided when making the request.

      +
      +
      +

      Parameters

      +
        +
      • +
        defaultPort: number
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): ConsulClientOptions
      • +
    +
      +
    • + +
      +
      +

      Add an enabled SSL/TLS protocols, appended to the ordered protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setFollowRedirects

    + +
      +
    • + +
      +
      +

      Configure the default behavior of the client to follow HTTP {@code 30x} redirections.

      +
      +
      +

      Parameters

      +
        +
      • +
        followRedirects: boolean
        +
        +

        true when a redirect is followed

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setForceSni

    + +
      +
    • + +
      +
      +

      By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting + this property to {@code true} forces the server name to be always sent.

      +
      +
      +

      Parameters

      +
        +
      • +
        forceSni: boolean
        +
        +

        true when the client should always use SNI on TLS/SSL connections

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHttp2ClearTextUpgrade

    + +
      +
    • + +
      +
      +

      Set to {@code true} when an h2c connection is established using an HTTP/1.1 upgrade request, and {@code false} + when an h2c connection is established directly (with prior knowledge).

      +
      +
      +

      Parameters

      +
        +
      • +
        http2ClearTextUpgrade: boolean
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHttp2ConnectionWindowSize

    + +
      +
    • + +
      +
      +

      Set the default HTTP/2 connection window size. It overrides the initial window + size set by {@link Http2Settings#getInitialWindowSize}, so the connection window size + is greater than for its streams, in order the data throughput. +

      + A value of {@code -1} reuses the initial window size setting.

      +
      +
      +

      Parameters

      +
        +
      • +
        http2ConnectionWindowSize: number
        +
        +

        the window size applied to the connection

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHttp2KeepAliveTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2KeepAliveTimeout: number
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    +
    +
    + +

    setHttp2MaxPoolSize

    + +
      +
    • + +
      +
      +

      Set the maximum pool size for HTTP/2 connections

      +
      +
      +

      Parameters

      +
        +
      • +
        http2MaxPoolSize: number
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHttp2MultiplexingLimit

    + +
      +
    • + +
      +
      +

      Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number + of streams the client can create for a connection. The effective number of streams for a + connection is the min of this value and the server's initial settings. +

      + Setting the value to {@code -1} means to use the value sent by the server's initial settings. + {@code -1} is the default value.

      +
      +
      +

      Parameters

      +
        +
      • +
        http2MultiplexingLimit: number
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +
      +
      +

      Set the idle timeout, in seconds. zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +
      +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        +

        the timeout, in seconds

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWebsocketFrameSize

    -
    maxWebsocketFrameSize: number
    - -
    -
    -

    Set the max websocket frame size

    -
    -
    -
    param
    -

    the max frame size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        +

        specify time unit.

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWebsocketMessageSize

    -
    maxWebsocketMessageSize: number
    - -
    -
    -

    Set the max websocket message size

    -
    -
    -
    param
    -

    the max message size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setInitialSettings

    + +
      +
    • + +
      +
      +

      Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

      +
      +
      +

      Parameters

      +
        +
      • +
        initialSettings: Http2Settings
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - -
    -
    -

    Set the metrics name identifying the reported metrics, useful for grouping metrics - with the same name.

    -
    -
    -
    param
    -

    the metrics name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setJdkSslEngineOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    setKeepAlive

    + +
      +
    • + +
      +
      +

      Set whether keep alive is enabled on the client

      +
      +
      +

      Parameters

      +
        +
      • +
        keepAlive: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - -
    -
    -

    Set the key/cert store options in pem format.

    -
    -
    -
    param
    -

    the options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setKeepAliveTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keepAliveTimeout: number
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - -
    -
    -

    Set the trust options.

    -
    -
    -
    param
    -

    the trust options

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - -
    -
    -

    Set the key/cert options in pfx format.

    -
    -
    -
    param
    -

    the key cert options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setLocalAddress

    + +
      +
    • + +
      +
      +

      Set the local interface to bind for network connections. When the local address is null, + it will pick any local address, the default local address is null.

      +
      +
      +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        +

        the local address

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - -
    -
    -

    Set the trust options in pfx format

    -
    -
    -
    param
    -

    the trust options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setLogActivity

    + +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        +

        true for logging the network activity

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pipelining

    -
    pipelining: boolean
    - -
    -
    -

    Set whether pipe-lining is enabled on the client

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setMaxChunkSize

    + +
      +
    • + +
      +
      +

      Set the maximum HTTP chunk size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxChunkSize: number
        +
        +

        the maximum chunk size

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pipeliningLimit

    -
    pipeliningLimit: number
    - -
    -
    -

    Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

    -
    -
    -
    param
    -

    the limit of pending requests

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setMaxHeaderSize

    + +
      +
    • + +
      +
      +

      Set the maximum length of all headers for HTTP/1.x .

      +
      +
      +

      Parameters

      +
        +
      • +
        maxHeaderSize: number
        +
        +

        the new maximum length

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    poolCleanerPeriod

    -
    poolCleanerPeriod: number
    - +
    + +

    setMaxInitialLineLength

    + +
      +
    • + +
      +
      +

      Set the maximum length of the initial line for HTTP/1.x (e.g. {@code "HTTP/1.1 200 OK"})

      +
      +
      +

      Parameters

      +
        +
      • +
        maxInitialLineLength: number
        +
        +

        the new maximum initial length

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    protocolVersion

    -
    protocolVersion: HttpVersion
    - -
    -
    -

    Set the protocol version.

    -
    -
    -
    param
    -

    the protocol version

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setMaxPoolSize

    + +
      +
    • + +
      +
      +

      Set the maximum pool size for connections

      +
      +
      +

      Parameters

      +
        +
      • +
        maxPoolSize: number
        +
        +

        the maximum pool size

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - -
    -
    -

    Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    -
    -
    -
    param
    -

    proxy options object

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setMaxRedirects

    + +
      +
    • + +
      +
      +

      Set to {@code maxRedirects} the maximum number of redirection a request can follow.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxRedirects: number
        +
        +

        the maximum number of redirection

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - -
    -
    -

    Set the TCP receive buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setMaxWaitQueueSize

    + +
      +
    • + +
      +
      +

      Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in + a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWaitQueueSize: number
        +
        +

        the maximum number of waiting requests

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - -
    -
    -

    Set the value of reuse address

    -
    -
    -
    param
    -

    the value of reuse address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setMaxWebsocketFrameSize

    + +
      +
    • + +
      +
      +

      Set the max websocket frame size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWebsocketFrameSize: number
        +
        +

        the max frame size, in bytes

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWebsocketMessageSize

    + +
      +
    • + +
      +
      +

      Set the max websocket message size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWebsocketMessageSize: number
        +
        +

        the max message size, in bytes

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMetricsName

    + +
      +
    • + +
      +
      +

      Set the metrics name identifying the reported metrics, useful for grouping metrics + with the same name.

      +
      +
      +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        +

        the metrics name

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options.

      +
      +
      +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        +

        the trust options

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPipelining

    + +
      +
    • + +
      +
      +

      Set whether pipe-lining is enabled on the client

      +
      +
      +

      Parameters

      +
        +
      • +
        pipelining: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPipeliningLimit

    + +
      +
    • + +
      +
      +

      Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

      +
      +
      +

      Parameters

      +
        +
      • +
        pipeliningLimit: number
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPoolCleanerPeriod

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        poolCleanerPeriod: number
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    +
    +
    + +

    setProtocolVersion

    + +
      +
    • + +
      +
      +

      Set the protocol version.

      +
      +
      +

      Parameters

      +
        +
      • +
        protocolVersion: HttpVersion
        +
        +

        the protocol version

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setProxyOptions

    + +
      +
    • + +
      +
      +

      Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

      +
      +
      +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        +

        proxy options object

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setReuseAddress

    + +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        +

        the value of reuse address

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setReusePort

    + +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        +

        the value of reuse port

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSendBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSendUnmaskedFrames

    + +
      +
    • + +
      +
      +

      Set true when the client wants to skip frame masking. + You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. + It's false as default.

      +
      +
      +

      Parameters

      +
        +
      • +
        sendUnmaskedFrames: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSoLinger

    + +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        +

        true if SO_linger is enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTcpCork

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        +

        the cork value

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        +

        the fast open value

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - -
    -
    -

    Set the value of reuse port. -

    - This is only supported by native transports.

    -
    -
    -
    param
    -

    the value of reuse port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        +

        true if TCP keep alive is enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - -
    -
    -

    Set the TCP send buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        +

        true if TCP no delay is enabled (Nagle disabled)

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sendUnmaskedFrames

    -
    sendUnmaskedFrames: boolean
    - -
    -
    -

    Set true when the client wants to skip frame masking. - You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. - It's false as default.

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        +

        the quick ack value

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - -
    -
    -

    Set whether SO_linger keep alive is enabled

    -
    -
    -
    param
    -

    true if SO_linger is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTimeout

    + +
      +
    • + +
      +
      +

      Sets the amount of time (in milliseconds) after which if the request does not return any data + within the timeout period an failure will be passed to the handler and the request will be closed.

      +
      +
      +

      Parameters

      +
        +
      • +
        timeout: number
        +
        • +
      +

      Returns ConsulClientOptions

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set whether SSL/TLS is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    setTrafficClass

    + +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        +

        the value of traffic class

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - -
    -
    -

    Enable the {@code TCP_CORK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the cork value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrustAll

    + +
      +
    • + +
      +
      +

      Set whether all server certificates should be trusted

      +
      +
      +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        +

        true if all should be trusted

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - -
    -
    -

    Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

    -
    -
    -
    param
    -

    the fast open value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - -
    -
    -

    Set whether TCP keep alive is enabled

    -
    -
    -
    param
    -

    true if TCP keep alive is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTryUseCompression

    + +
      +
    • + +
      +
      +

      Set whether compression is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tryUseCompression: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - -
    -
    -

    Set whether TCP no delay is enabled

    -
    -
    -
    param
    -

    true if TCP no delay is enabled (Nagle disabled)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTryUsePerFrameWebsocketCompression

    +
      +
    • setTryUsePerFrameWebsocketCompression(tryUsePerFrameWebsocketCompression: boolean): ConsulClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUsePerFrameWebsocketCompression: boolean
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - -
    -
    -

    Enable the {@code TCP_QUICKACK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the quick ack value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTryUsePerMessageWebsocketCompression

    +
      +
    • setTryUsePerMessageWebsocketCompression(tryUsePerMessageWebsocketCompression: boolean): ConsulClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUsePerMessageWebsocketCompression: boolean
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    timeout

    -
    timeout: number
    - -
    -
    -

    Sets the amount of time (in milliseconds) after which if the request does not return any data - within the timeout period an failure will be passed to the handler and the request will be closed.

    -
    -
    -
    param
    -

    timeout in milliseconds

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    setUseAlpn

    + +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        +

        true when Application-Layer Protocol Negotiation should be used

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - -
    -
    -

    Set the value of traffic class

    -
    -
    -
    param
    -

    the value of traffic class

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        +

        true if pooled buffers enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - -
    -
    -

    Set whether all server certificates should be trusted

    -
    -
    -
    param
    -

    true if all should be trusted

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    setUserAgent

    + +
      +
    • + +
      +
      +

      Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

      +
      +
      +

      Parameters

      +
        +
      • +
        userAgent: string
        +
        +

        user agent header value

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - -
    -
    -

    Set the trust options in jks format, aka Java truststore

    -
    -
    -
    param
    -

    the trust options in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setUserAgentEnabled

    + +
      +
    • + +
      +
      +

      Sets whether the Web Client should send a user agent header. Defaults to true.

      +
      +
      +

      Parameters

      +
        +
      • +
        userAgentEnabled: boolean
        +
        +

        true to send a user agent header, false otherwise

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tryUseCompression

    -
    tryUseCompression: boolean
    - -
    -
    -

    Set whether compression is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setVerifyHost

    + +
      +
    • + +
      +
      +

      Set whether hostname verification is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        verifyHost: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns ConsulClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - -
    -
    -

    Set the ALPN usage.

    -
    -
    -
    param
    -

    true when Application-Layer Protocol Negotiation should be used

    -
    -
    -
    +
    + +

    setWebsocketCompressionAllowClientNoContext

    +
      +
    • setWebsocketCompressionAllowClientNoContext(websocketCompressionAllowClientNoContext: boolean): ConsulClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionAllowClientNoContext: boolean
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - -
    -
    -

    Set whether Netty pooled buffers are enabled

    -
    -
    -
    param
    -

    true if pooled buffers enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketCompressionLevel

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionLevel: number
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    userAgent

    -
    userAgent: string
    - -
    -
    -

    Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

    -
    -
    -
    param
    -

    user agent header value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketCompressionRequestServerNoContext

    +
      +
    • setWebsocketCompressionRequestServerNoContext(websocketCompressionRequestServerNoContext: boolean): ConsulClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionRequestServerNoContext: boolean
        +
        • +
      +

      Returns ConsulClientOptions

      +
      • +
    -
    - -

    userAgentEnabled

    -
    userAgentEnabled: boolean
    - -
    -
    -

    Sets whether the Web Client should send a user agent header. Defaults to true.

    -
    -
    -
    param
    -

    true to send a user agent header, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    tryUsePerFrameWebsocketCompression

    +
      +
    • tryUsePerFrameWebsocketCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    verifyHost

    -
    verifyHost: boolean
    - -
    -
    -

    Set whether hostname verification is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    tryUsePerMessageWebsocketCompression

    +
      +
    • tryUsePerMessageWebsocketCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    @@ -1692,206 +4229,449 @@

    verifyHost

  • ConsulClientOptions
    • @@ -1987,10 +4767,10 @@

    verifyHost

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/coordinate.html b/docs/@vertx/consul-client/classes/coordinate.html index 06910dd1b..1a4e47a44 100644 --- a/docs/@vertx/consul-client/classes/coordinate.html +++ b/docs/@vertx/consul-client/classes/coordinate.html @@ -77,134 +77,340 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    adj

    -
    adj: number
    - -
    -
    -

    Set adjustment

    -
    -
    -
    param
    -

    adjustment

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Coordinate

      +
      • +
    • + +

      Parameters

      + +

      Returns Coordinate

      +
      • +
    -
    - -

    err

    -
    err: number
    - -
    -
    -

    Set error

    -
    -
    -
    param
    -

    error

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAdj

    +
      +
    • getAdj(): number
      • +
    +
      +
    • + +
      +
      +

      Set adjustment

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    height

    -
    height: number
    - -
    -
    -

    Set height

    -
    -
    -
    param
    -

    height

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getErr

    +
      +
    • getErr(): number
      • +
    +
      +
    • + +
      +
      +

      Set error

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    node

    -
    node: string
    - -
    -
    -

    Set name of node

    -
    -
    -
    param
    -

    name of node

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getHeight

    +
      +
    • getHeight(): number
      • +
    +
      +
    • + +
      +
      +

      Set height

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    vec

    -
    vec: number
    - -
    -
    -

    Set vector

    -
    -
    -
    param
    -

    vector

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNode

    +
      +
    • getNode(): string
      • +
    +
      +
    • + +
      +
      +

      Set name of node

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getVec

    +
      +
    • getVec(): number
      • +
    +
      +
    • + +
      +
      +

      Set vector

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setAdj

    + +
      +
    • + +
      +
      +

      Set adjustment

      +
      +
      +

      Parameters

      +
        +
      • +
        adj: number
        +
        +

        adjustment

        +
        +
        • +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setErr

    + +
      +
    • + +
      +
      +

      Set error

      +
      +
      +

      Parameters

      +
        +
      • +
        err: number
        +
        +

        error

        +
        +
        • +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setHeight

    + +
      +
    • + +
      +
      +

      Set height

      +
      +
      +

      Parameters

      +
        +
      • +
        height: number
        +
        +

        height

        +
        +
        • +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    + +
      +
    • + +
      +
      +

      Set name of node

      +
      +
      +

      Parameters

      +
        +
      • +
        node: string
        +
        +

        name of node

        +
        +
        • +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setVec

    + +
      +
    • + +
      +
      +

      Set vector

      +
      +
      +

      Parameters

      +
        +
      • +
        vec: number
        +
        +

        vector

        +
        +
        • +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    @@ -247,20 +453,38 @@

    vec

  • Coordinate
    • @@ -353,10 +577,10 @@

    vec

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/coordinatelist.html b/docs/@vertx/consul-client/classes/coordinatelist.html index 5ac016e14..7c2f0e9e5 100644 --- a/docs/@vertx/consul-client/classes/coordinatelist.html +++ b/docs/@vertx/consul-client/classes/coordinatelist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested coordinates

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    list

    -
    list: Coordinate
    - -
    -
    -

    Set list of coordinates

    -
    -
    -
    param
    -

    the list of coordinates

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested coordinates

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of coordinates

      +
      +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested coordinates

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns CoordinateList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of coordinates

      +
      +
      +

      Parameters

      +
        +
      • +
        list: Coordinate
        +
        +

        the list of coordinates

        +
        +
        • +
      +

      Returns CoordinateList

      +

      reference to this, for fluency

      +
      • +
    @@ -178,11 +285,20 @@

    list

  • CoordinateList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/dccoordinates.html b/docs/@vertx/consul-client/classes/dccoordinates.html index db5e0def1..94434cf54 100644 --- a/docs/@vertx/consul-client/classes/dccoordinates.html +++ b/docs/@vertx/consul-client/classes/dccoordinates.html @@ -77,62 +77,166 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    datacenter

    -
    datacenter: string
    - -
    -
    -

    Set datacenter

    -
    -
    -
    param
    -

    the datacenter

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    servers

    -
    servers: Coordinate
    - -
    -
    -

    Set list of servers in datacenter

    -
    -
    -
    param
    -

    list of servers in datacenter

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getDatacenter

    +
      +
    • getDatacenter(): string
      • +
    +
      +
    • + +
      +
      +

      Set datacenter

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getServers

    + +
      +
    • + +
      +
      +

      Set list of servers in datacenter

      +
      +
      +

      Returns Coordinate

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setDatacenter

    + +
      +
    • + +
      +
      +

      Set datacenter

      +
      +
      +

      Parameters

      +
        +
      • +
        datacenter: string
        +
        • +
      +

      Returns DcCoordinates

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setServers

    + +
      +
    • + +
      +
      +

      Set list of servers in datacenter

      +
      +
      +

      Parameters

      +
        +
      • +
        servers: Coordinate
        +
        +

        list of servers in datacenter

        +
        +
        • +
      +

      Returns DcCoordinates

      +

      reference to this, for fluency

      +
      • +
    @@ -181,11 +285,20 @@

    servers

  • DcCoordinates
    • @@ -272,10 +385,10 @@

    servers

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/event.html b/docs/@vertx/consul-client/classes/event.html index a479bd246..113683f45 100644 --- a/docs/@vertx/consul-client/classes/event.html +++ b/docs/@vertx/consul-client/classes/event.html @@ -77,206 +77,511 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set ID of event

    -
    -
    -
    param
    -

    ID of event

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Event

      +
      • +
    • + +

      Parameters

      + +

      Returns Event

      +
      • +
    -
    - -

    lTime

    -
    lTime: number
    - -
    -
    -

    Set the Lamport clock time

    -
    -
    -
    param
    -

    the Lamport clock time

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set ID of event

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set name of event

    -
    -
    -
    param
    -

    name of event

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getLTime

    +
      +
    • getLTime(): number
      • +
    +
      +
    • + +
      +
      +

      Set the Lamport clock time

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    node

    -
    node: string
    - -
    -
    -

    Set regular expression to filter by node name

    -
    -
    -
    param
    -

    regular expression to filter by node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set name of event

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    payload

    -
    payload: string
    - -
    -
    -

    Set payload of event

    -
    -
    -
    param
    -

    payload of event

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNode

    +
      +
    • getNode(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by node name

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    service

    -
    service: string
    - -
    -
    -

    Set regular expression to filter by service

    -
    -
    -
    param
    -

    regular expression to filter by service

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getPayload

    +
      +
    • getPayload(): string
      • +
    +
      +
    • + +
      +
      +

      Set payload of event

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tag

    -
    tag: string
    - -
    -
    -

    Set regular expression to filter by tag

    -
    -
    -
    param
    -

    regular expression to filter by tag

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getService

    +
      +
    • getService(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by service

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    version

    -
    version: number
    - -
    -
    -

    Set version

    -
    -
    -
    param
    -

    version

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getTag

    +
      +
    • getTag(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by tag

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getVersion

    +
      +
    • getVersion(): number
      • +
    +
      +
    • + +
      +
      +

      Set version

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    +
      +
    • setId(id: string): Event
      • +
    +
      +
    • + +
      +
      +

      Set ID of event

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        ID of event

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setLTime

    +
      +
    • setLTime(lTime: number): Event
      • +
    +
      +
    • + +
      +
      +

      Set the Lamport clock time

      +
      +
      +

      Parameters

      +
        +
      • +
        lTime: number
        +
        +

        the Lamport clock time

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    +
      +
    • setName(name: string): Event
      • +
    +
      +
    • + +
      +
      +

      Set name of event

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of event

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    +
      +
    • setNode(node: string): Event
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by node name

      +
      +
      +

      Parameters

      +
        +
      • +
        node: string
        +
        +

        regular expression to filter by node name

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setPayload

    +
      +
    • setPayload(payload: string): Event
      • +
    +
      +
    • + +
      +
      +

      Set payload of event

      +
      +
      +

      Parameters

      +
        +
      • +
        payload: string
        +
        +

        payload of event

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setService

    +
      +
    • setService(service: string): Event
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by service

      +
      +
      +

      Parameters

      +
        +
      • +
        service: string
        +
        +

        regular expression to filter by service

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTag

    +
      +
    • setTag(tag: string): Event
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by tag

      +
      +
      +

      Parameters

      +
        +
      • +
        tag: string
        +
        +

        regular expression to filter by tag

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setVersion

    +
      +
    • setVersion(version: number): Event
      • +
    +
      +
    • + +
      +
      +

      Set version

      +
      +
      +

      Parameters

      +
        +
      • +
        version: number
        +
        +

        version

        +
        +
        • +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    @@ -328,29 +633,56 @@

    version

  • Event
    • @@ -434,10 +766,10 @@

    version

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/eventlist.html b/docs/@vertx/consul-client/classes/eventlist.html index 54b215247..eb03a7658 100644 --- a/docs/@vertx/consul-client/classes/eventlist.html +++ b/docs/@vertx/consul-client/classes/eventlist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested events

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns EventList

      +
      • +
    • + +

      Parameters

      + +

      Returns EventList

      +
      • +
    -
    - -

    list

    -
    list: Event
    - -
    -
    -

    Set list of events

    -
    -
    -
    param
    -

    the list of events

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested events

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of events

      +
      +
      +

      Returns Event

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested events

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns EventList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of events

      +
      +
      +

      Parameters

      +
        +
      • +
        list: Event
        +
        +

        the list of events

        +
        +
        • +
      +

      Returns EventList

      +

      reference to this, for fluency

      +
      • +
    @@ -187,11 +294,20 @@

    list

  • EventList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/eventlistoptions.html b/docs/@vertx/consul-client/classes/eventlistoptions.html index 3aea864f2..94075b78f 100644 --- a/docs/@vertx/consul-client/classes/eventlistoptions.html +++ b/docs/@vertx/consul-client/classes/eventlistoptions.html @@ -77,62 +77,166 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    blockingOptions

    -
    blockingOptions: BlockingQueryOptions
    - -
    -
    -

    Set options for blocking query

    -
    -
    -
    param
    -

    the blocking options

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set event name for filtering on events

    -
    -
    -
    param
    -

    name of the event

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Returns BlockingQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set event name for filtering on events

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Parameters

      + +

      Returns EventListOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Set event name for filtering on events

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of the event

        +
        +
        • +
      +

      Returns EventListOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -190,11 +294,20 @@

    name

  • EventListOptions
    • @@ -272,10 +385,10 @@

    name

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/eventoptions.html b/docs/@vertx/consul-client/classes/eventoptions.html index 49655ec7c..1d3724e2f 100644 --- a/docs/@vertx/consul-client/classes/eventoptions.html +++ b/docs/@vertx/consul-client/classes/eventoptions.html @@ -77,110 +77,283 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    node

    -
    node: string
    - -
    -
    -

    Set regular expression to filter by node name

    -
    -
    -
    param
    -

    regular expression to filter by node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    payload

    -
    payload: string
    - -
    -
    -

    Set payload of event

    -
    -
    -
    param
    -

    payload of event

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getNode

    +
      +
    • getNode(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by node name

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    service

    -
    service: string
    - -
    -
    -

    Set regular expression to filter by service

    -
    -
    -
    param
    -

    regular expression to filter by service

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getPayload

    +
      +
    • getPayload(): string
      • +
    +
      +
    • + +
      +
      +

      Set payload of event

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tag

    -
    tag: string
    - -
    -
    -

    Set regular expression to filter by tag

    -
    -
    -
    param
    -

    regular expression to filter by tag

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getService

    +
      +
    • getService(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by service

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTag

    +
      +
    • getTag(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression to filter by tag

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    + +
      +
    • + +
      +
      +

      Set regular expression to filter by node name

      +
      +
      +

      Parameters

      +
        +
      • +
        node: string
        +
        +

        regular expression to filter by node name

        +
        +
        • +
      +

      Returns EventOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setPayload

    + +
      +
    • + +
      +
      +

      Set payload of event

      +
      +
      +

      Parameters

      +
        +
      • +
        payload: string
        +
        +

        payload of event

        +
        +
        • +
      +

      Returns EventOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setService

    + +
      +
    • + +
      +
      +

      Set regular expression to filter by service

      +
      +
      +

      Parameters

      +
        +
      • +
        service: string
        +
        +

        regular expression to filter by service

        +
        +
        • +
      +

      Returns EventOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTag

    + +
      +
    • + +
      +
      +

      Set regular expression to filter by tag

      +
      +
      +

      Parameters

      +
        +
      • +
        tag: string
        +
        +

        regular expression to filter by tag

        +
        +
        • +
      +

      Returns EventOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -241,17 +414,32 @@

    tag

  • EventOptions
    • @@ -326,10 +514,10 @@

    tag

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/keyvalue.html b/docs/@vertx/consul-client/classes/keyvalue.html index 068497116..6eba22a78 100644 --- a/docs/@vertx/consul-client/classes/keyvalue.html +++ b/docs/@vertx/consul-client/classes/keyvalue.html @@ -77,182 +77,454 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    createIndex

    -
    createIndex: number
    - -
    -
    -

    Set the internal index value that represents when the entry was created.

    -
    -
    -
    param
    -

    the internal index value that represents when the entry was created.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns KeyValue

      +
      • +
    • + +

      Parameters

      + +

      Returns KeyValue

      +
      • +
    -
    - -

    flags

    -
    flags: number
    - -
    -
    -

    Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

    -
    -
    -
    param
    -

    the flags attached to this entry. Clients can choose to use this however makes sense for their application.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getCreateIndex

    +
      +
    • getCreateIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the internal index value that represents when the entry was created.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    key

    -
    key: string
    - -
    -
    -

    Set the key

    -
    -
    -
    param
    -

    the key

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getFlags

    +
      +
    • getFlags(): number
      • +
    +
      +
    • + +
      +
      +

      Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    lockIndex

    -
    lockIndex: number
    - -
    -
    -

    Set the number of times this key has successfully been acquired in a lock.

    -
    -
    -
    param
    -

    the number of times this key has successfully been acquired in a lock.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getKey

    +
      +
    • getKey(): string
      • +
    +
      +
    • + +
      +
      +

      Set the key

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    modifyIndex

    -
    modifyIndex: number
    - -
    -
    -

    Set the last index that modified this key.

    -
    -
    -
    param
    -

    the last index that modified this key.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getLockIndex

    +
      +
    • getLockIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the number of times this key has successfully been acquired in a lock.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    session

    -
    session: string
    - -
    -
    -

    Set the session that owns the lock

    -
    -
    -
    param
    -

    the session that owns the lock

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getModifyIndex

    +
      +
    • getModifyIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the last index that modified this key.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    value

    -
    value: string
    - -
    -
    -

    Set the value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getSession

    +
      +
    • getSession(): string
      • +
    +
      +
    • + +
      +
      +

      Set the session that owns the lock

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getValue

    +
      +
    • getValue(): string
      • +
    +
      +
    • + +
      +
      +

      Set the value

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setCreateIndex

    +
      +
    • setCreateIndex(createIndex: number): KeyValue
      • +
    +
      +
    • + +
      +
      +

      Set the internal index value that represents when the entry was created.

      +
      +
      +

      Parameters

      +
        +
      • +
        createIndex: number
        +
        +

        the internal index value that represents when the entry was created.

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setFlags

    + +
      +
    • + +
      +
      +

      Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

      +
      +
      +

      Parameters

      +
        +
      • +
        flags: number
        +
        +

        the flags attached to this entry. Clients can choose to use this however makes sense for their application.

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setKey

    + +
      +
    • + +
      +
      +

      Set the key

      +
      +
      +

      Parameters

      +
        +
      • +
        key: string
        +
        +

        the key

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setLockIndex

    +
      +
    • setLockIndex(lockIndex: number): KeyValue
      • +
    +
      +
    • + +
      +
      +

      Set the number of times this key has successfully been acquired in a lock.

      +
      +
      +

      Parameters

      +
        +
      • +
        lockIndex: number
        +
        +

        the number of times this key has successfully been acquired in a lock.

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setModifyIndex

    +
      +
    • setModifyIndex(modifyIndex: number): KeyValue
      • +
    +
      +
    • + +
      +
      +

      Set the last index that modified this key.

      +
      +
      +

      Parameters

      +
        +
      • +
        modifyIndex: number
        +
        +

        the last index that modified this key.

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setSession

    +
      +
    • setSession(session: string): KeyValue
      • +
    +
      +
    • + +
      +
      +

      Set the session that owns the lock

      +
      +
      +

      Parameters

      +
        +
      • +
        session: string
        +
        +

        the session that owns the lock

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setValue

    + +
      +
    • + +
      +
      +

      Set the value

      +
      +
      +

      Parameters

      +
        +
      • +
        value: string
        +
        +

        the value

        +
        +
        • +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    @@ -316,26 +588,50 @@

    value

  • KeyValue
    • @@ -407,10 +703,10 @@

    value

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/keyvaluelist.html b/docs/@vertx/consul-client/classes/keyvaluelist.html index 3aefa9d6f..dbe8ffa93 100644 --- a/docs/@vertx/consul-client/classes/keyvaluelist.html +++ b/docs/@vertx/consul-client/classes/keyvaluelist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    list

    -
    list: KeyValue
    - -
    -
    -

    Set list of key/value pairs

    -
    -
    -
    param
    -

    list of key/value pairs

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of key/value pairs

      +
      +
      +

      Returns KeyValue

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns KeyValueList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of key/value pairs

      +
      +
      +

      Parameters

      +
        +
      • +
        list: KeyValue
        +
        +

        list of key/value pairs

        +
        +
        • +
      +

      Returns KeyValueList

      +

      reference to this, for fluency

      +
      • +
    @@ -199,11 +306,20 @@

    list

  • KeyValueList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/keyvalueoptions.html b/docs/@vertx/consul-client/classes/keyvalueoptions.html index 995a725a6..40153e2b8 100644 --- a/docs/@vertx/consul-client/classes/keyvalueoptions.html +++ b/docs/@vertx/consul-client/classes/keyvalueoptions.html @@ -77,115 +77,294 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    acquireSession

    -
    acquireSession: string
    - -
    -
    -

    Set session ID for lock acquisition operation.

    -
    -
    -
    param
    -

    the ID of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    casIndex

    -
    casIndex: number
    - -
    -
    -

    Set the Check-And-Set index. If the index is {@code 0}, Consul will only put the key if it does not already exist. - If the index is non-zero, the key is only set if the index matches the ModifyIndex of that key.

    -
    -
    -
    param
    -

    the Check-And-Set index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    see
    -

    KeyValue#getModifyIndex()

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAcquireSession

    +
      +
    • getAcquireSession(): string
      • +
    +
      +
    • + +
      +
      +

      Set session ID for lock acquisition operation.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    flags

    -
    flags: number
    - -
    -
    -

    Set the flags. Flags is an value between {@code 0} and 264-1 that can be attached to each entry. - Clients can choose to use this however makes sense for their application.

    -
    -
    -
    param
    -

    the flags

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getCasIndex

    +
      +
    • getCasIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the Check-And-Set index. If the index is {@code 0}, Consul will only put the key if it does not already exist. + If the index is non-zero, the key is only set if the index matches the ModifyIndex of that key.

      +
      +
      +
      see
      +

      KeyValue#getModifyIndex()

      +
      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    releaseSession

    -
    releaseSession: string
    - -
    -
    -

    Set session ID for lock release operation.

    -
    -
    -
    param
    -

    the ID of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getFlags

    +
      +
    • getFlags(): number
      • +
    +
      +
    • + +
      +
      +

      Set the flags. Flags is an value between {@code 0} and 264-1 that can be attached to each entry. + Clients can choose to use this however makes sense for their application.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getReleaseSession

    +
      +
    • getReleaseSession(): string
      • +
    +
      +
    • + +
      +
      +

      Set session ID for lock release operation.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setAcquireSession

    + +
      +
    • + +
      +
      +

      Set session ID for lock acquisition operation.

      +
      +
      +

      Parameters

      +
        +
      • +
        acquireSession: string
        +
        +

        the ID of session

        +
        +
        • +
      +

      Returns KeyValueOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setCasIndex

    + +
      +
    • + +
      +
      +

      Set the Check-And-Set index. If the index is {@code 0}, Consul will only put the key if it does not already exist. + If the index is non-zero, the key is only set if the index matches the ModifyIndex of that key.

      +
      +
      +
      see
      +

      KeyValue#getModifyIndex()

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        casIndex: number
        +
        • +
      +

      Returns KeyValueOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setFlags

    + +
      +
    • + +
      +
      +

      Set the flags. Flags is an value between {@code 0} and 264-1 that can be attached to each entry. + Clients can choose to use this however makes sense for their application.

      +
      +
      +

      Parameters

      +
        +
      • +
        flags: number
        +
        +

        the flags

        +
        +
        • +
      +

      Returns KeyValueOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setReleaseSession

    + +
      +
    • + +
      +
      +

      Set session ID for lock release operation.

      +
      +
      +

      Parameters

      +
        +
      • +
        releaseSession: string
        +
        +

        the ID of session

        +
        +
        • +
      +

      Returns KeyValueOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -255,17 +434,32 @@

    releaseSession

  • KeyValueOptions
    • @@ -331,10 +525,10 @@

    releaseSession

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/maintenanceoptions.html b/docs/@vertx/consul-client/classes/maintenanceoptions.html index c86dcf1ee..24b8002d5 100644 --- a/docs/@vertx/consul-client/classes/maintenanceoptions.html +++ b/docs/@vertx/consul-client/classes/maintenanceoptions.html @@ -77,88 +77,230 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    enable

    -
    enable: boolean
    - -
    -
    -

    Set maintenance mode to enabled: {@code true} to enter maintenance mode or {@code false} to resume normal operation. - This flag is required.

    -
    -
    -
    param
    -

    maintenance mode

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set the ID of service. This field is required.

    -
    -
    -
    param
    -

    the ID of service

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of service. This field is required.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    reason

    -
    reason: string
    - -
    -
    -

    Set the reason message. If provided, its value should be a text string explaining the reason for placing - the service into maintenance mode. This is simply to aid human operators.

    -
    -
    -
    param
    -

    the reason message

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getReason

    +
      +
    • getReason(): string
      • +
    +
      +
    • + +
      +
      +

      Set the reason message. If provided, its value should be a text string explaining the reason for placing + the service into maintenance mode. This is simply to aid human operators.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    isEnable

    +
      +
    • isEnable(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set maintenance mode to enabled: {@code true} to enter maintenance mode or {@code false} to resume normal operation. + This flag is required.

      +
      +
      +

      Returns boolean

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setEnable

    + +
      +
    • + +
      +
      +

      Set maintenance mode to enabled: {@code true} to enter maintenance mode or {@code false} to resume normal operation. + This flag is required.

      +
      +
      +

      Parameters

      +
        +
      • +
        enable: boolean
        +
        +

        maintenance mode

        +
        +
        • +
      +

      Returns MaintenanceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set the ID of service. This field is required.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the ID of service

        +
        +
        • +
      +

      Returns MaintenanceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setReason

    + +
      +
    • + +
      +
      +

      Set the reason message. If provided, its value should be a text string explaining the reason for placing + the service into maintenance mode. This is simply to aid human operators.

      +
      +
      +

      Parameters

      +
        +
      • +
        reason: string
        +
        +

        the reason message

        +
        +
        • +
      +

      Returns MaintenanceOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -231,14 +373,26 @@

    reason

  • MaintenanceOptions
    • @@ -301,10 +455,10 @@

    reason

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/node.html b/docs/@vertx/consul-client/classes/node.html index 1df8f6ece..e17c406e5 100644 --- a/docs/@vertx/consul-client/classes/node.html +++ b/docs/@vertx/consul-client/classes/node.html @@ -77,110 +77,280 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    address

    -
    address: string
    - -
    -
    -

    Set node address

    -
    -
    -
    param
    -

    node address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Node

      +
      • +
    • + +

      Parameters

      + +

      Returns Node

      +
      • +
    -
    - -

    lanAddress

    -
    lanAddress: string
    - -
    -
    -

    Set node lan address

    -
    -
    -
    param
    -

    node lan address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAddress

    +
      +
    • getAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set node address

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set node name

    -
    -
    -
    param
    -

    node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getLanAddress

    +
      +
    • getLanAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set node lan address

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    wanAddress

    -
    wanAddress: string
    - -
    -
    -

    Set node wan address

    -
    -
    -
    param
    -

    node wan address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set node name

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getWanAddress

    +
      +
    • getWanAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set node wan address

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setAddress

    +
      +
    • setAddress(address: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set node address

      +
      +
      +

      Parameters

      +
        +
      • +
        address: string
        +
        +

        node address

        +
        +
        • +
      +

      Returns Node

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setLanAddress

    +
      +
    • setLanAddress(lanAddress: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set node lan address

      +
      +
      +

      Parameters

      +
        +
      • +
        lanAddress: string
        +
        +

        node lan address

        +
        +
        • +
      +

      Returns Node

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    +
      +
    • setName(name: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set node name

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        • +
      +

      Returns Node

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setWanAddress

    +
      +
    • setWanAddress(wanAddress: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set node wan address

      +
      +
      +

      Parameters

      +
        +
      • +
        wanAddress: string
        +
        +

        node wan address

        +
        +
        • +
      +

      Returns Node

      +

      reference to this, for fluency

      +
      • +
    @@ -256,17 +426,32 @@

    wanAddress

  • Node
    • @@ -326,10 +511,10 @@

    wanAddress

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/nodelist.html b/docs/@vertx/consul-client/classes/nodelist.html index 452f937bd..c7af75812 100644 --- a/docs/@vertx/consul-client/classes/nodelist.html +++ b/docs/@vertx/consul-client/classes/nodelist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested list of nodes

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns NodeList

      +
      • +
    • + +

      Parameters

      + +

      Returns NodeList

      +
      • +
    -
    - -

    list

    -
    list: Node
    - -
    -
    -

    Set list of nodes

    -
    -
    -
    param
    -

    the list of nodes

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of nodes

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    +
      +
    • getList(): Node
      • +
    +
      +
    • + +
      +
      +

      Set list of nodes

      +
      +
      +

      Returns Node

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of nodes

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns NodeList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of nodes

      +
      +
      +

      Parameters

      +
        +
      • +
        list: Node
        +
        +

        the list of nodes

        +
        +
        • +
      +

      Returns NodeList

      +

      reference to this, for fluency

      +
      • +
    @@ -211,11 +318,20 @@

    list

  • NodeList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/nodequeryoptions.html b/docs/@vertx/consul-client/classes/nodequeryoptions.html index d2b12c8a0..d0ee681cc 100644 --- a/docs/@vertx/consul-client/classes/nodequeryoptions.html +++ b/docs/@vertx/consul-client/classes/nodequeryoptions.html @@ -77,62 +77,166 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    blockingOptions

    -
    blockingOptions: BlockingQueryOptions
    - -
    -
    -

    Set options for blocking query

    -
    -
    -
    param
    -

    the blocking options

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    near

    -
    near: string
    - -
    -
    -

    Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

    -
    -
    -
    param
    -

    the node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Returns BlockingQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getNear

    +
      +
    • getNear(): string
      • +
    +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Parameters

      + +

      Returns NodeQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNear

    + +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

      +
      +
      +

      Parameters

      +
        +
      • +
        near: string
        +
        +

        the node name

        +
        +
        • +
      +

      Returns NodeQueryOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -214,11 +318,20 @@

    near

  • NodeQueryOptions
    • @@ -272,10 +385,10 @@

    near

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/preparedquerydefinition.html b/docs/@vertx/consul-client/classes/preparedquerydefinition.html index 9cd8a14af..2a5a3f801 100644 --- a/docs/@vertx/consul-client/classes/preparedquerydefinition.html +++ b/docs/@vertx/consul-client/classes/preparedquerydefinition.html @@ -77,346 +77,844 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    dcs

    -
    dcs: string
    - -
    -
    -

    Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes - in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined - with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters. - A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN - and is listed in Datacenters.

    -
    -
    -
    param
    -

    the list of remote datacenters

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    dnsTtl

    -
    dnsTtl: string
    - -
    -
    -

    Set the TTL duration when query results are served over DNS. If this is specified, - it will take precedence over any Consul agent-specific configuration.

    -
    -
    -
    param
    -

    the TTL duration

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getDcs

    +
      +
    • getDcs(): string
      • +
    +
      +
    • + +
      +
      +

      Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes + in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined + with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters. + A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN + and is listed in Datacenters.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set ID of the query, always generated by Consul

    -
    -
    -
    param
    -

    ID of the query

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getDnsTtl

    +
      +
    • getDnsTtl(): string
      • +
    +
      +
    • + +
      +
      +

      Set the TTL duration when query results are served over DNS. If this is specified, + it will take precedence over any Consul agent-specific configuration.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    meta

    -
    meta: string
    - -
    -
    -

    Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes - with the given metadata values present.

    -
    -
    -
    param
    -

    list of key/value pairs

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set ID of the query, always generated by Consul

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set an optional friendly name that can be used to execute a query instead of using its ID

    -
    -
    -
    param
    -

    name of the query

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getMeta

    +
      +
    • getMeta(): string
      • +
    +
      +
    • + +
      +
      +

      Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes + with the given metadata values present.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    nearestN

    -
    nearestN: number
    - -
    -
    -

    Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network - round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server - handling the query to the servers in the remote datacenter is used to determine the priority.

    -
    -
    -
    param
    -

    number of nearest datacenters to query

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set an optional friendly name that can be used to execute a query instead of using its ID

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    passing

    -
    passing: boolean
    - -
    -
    -

    Specifies the behavior of the query's health check filtering. If this is set to false, the results will include - nodes with checks in the passing as well as the warning states. If this is set to true, - only nodes with checks in the passing state will be returned.

    -
    -
    -
    param
    -

    the passing flag

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNearestN

    +
      +
    • getNearestN(): number
      • +
    +
      +
    • + +
      +
      +

      Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network + round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server + handling the query to the servers in the remote datacenter is used to determine the priority.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    service

    -
    service: string
    - -
    -
    -

    Set the name of the service to query

    -
    -
    -
    param
    -

    service name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getPassing

    +
      +
    • getPassing(): boolean
      • +
    +
      +
    • + +
      +
      +

      Specifies the behavior of the query's health check filtering. If this is set to false, the results will include + nodes with checks in the passing as well as the warning states. If this is set to true, + only nodes with checks in the passing state will be returned.

      +
      +
      +

      Returns boolean

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    session

    -
    session: string
    - -
    -
    -

    Set the ID of an existing session. This provides a way to automatically remove a prepared query when - the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.

    -
    -
    -
    param
    -

    id of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getService

    +
      +
    • getService(): string
      • +
    +
      +
    • + +
      +
      +

      Set the name of the service to query

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tags

    -
    tags: string
    - -
    -
    -

    Set a list of service tags to filter the query results. For a service to pass the tag filter - it must have all of the required tags, and none of the excluded tags (prefixed with !).

    -
    -
    -
    param
    -

    list of service tags

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getSession

    +
      +
    • getSession(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of an existing session. This provides a way to automatically remove a prepared query when + the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    templateRegexp

    -
    templateRegexp: string
    - -
    -
    -

    Set regular expression which is used to extract fields from the entire name, once this template is selected.

    -
    -
    -
    param
    -

    a regular expression

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    see
    -

    Prepared Query Templates endpoint

    -
    -
    -
    +
    + +

    getTags

    +
      +
    • getTags(): string
      • +
    +
      +
    • + +
      +
      +

      Set a list of service tags to filter the query results. For a service to pass the tag filter + it must have all of the required tags, and none of the excluded tags (prefixed with !).

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    templateType

    -
    templateType: string
    - -
    -
    -

    The template type, which must be {@code name_prefix_match}. This means that the template will apply to - any query lookup with a name whose prefix matches the Name field of the template.

    -
    -
    -
    param
    -

    the query type

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    see
    -

    Prepared Query Templates endpoint

    -
    -
    -
    +
    + +

    getTemplateRegexp

    +
      +
    • getTemplateRegexp(): string
      • +
    +
      +
    • + +
      +
      +

      Set regular expression which is used to extract fields from the entire name, once this template is selected.

      +
      +
      +
      see
      +

      Prepared Query Templates endpoint

      +
      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    token

    -
    token: string
    - -
    -
    -

    Set the ACL token to use each time the query is executed. This allows queries to be executed by clients - with lesser or even no ACL Token, so this should be used with care.

    -
    -
    -
    param
    -

    the ACL token

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getTemplateType

    +
      +
    • getTemplateType(): string
      • +
    +
      +
    • + +
      +
      +

      The template type, which must be {@code name_prefix_match}. This means that the template will apply to + any query lookup with a name whose prefix matches the Name field of the template.

      +
      +
      +
      see
      +

      Prepared Query Templates endpoint

      +
      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getToken

    +
      +
    • getToken(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ACL token to use each time the query is executed. This allows queries to be executed by clients + with lesser or even no ACL Token, so this should be used with care.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setDcs

    + +
      +
    • + +
      +
      +

      Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes + in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined + with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters. + A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN + and is listed in Datacenters.

      +
      +
      +

      Parameters

      +
        +
      • +
        dcs: string
        +
        +

        the list of remote datacenters

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setDnsTtl

    + +
      +
    • + +
      +
      +

      Set the TTL duration when query results are served over DNS. If this is specified, + it will take precedence over any Consul agent-specific configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        dnsTtl: string
        +
        +

        the TTL duration

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set ID of the query, always generated by Consul

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        ID of the query

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setMeta

    + +
      +
    • + +
      +
      +

      Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes + with the given metadata values present.

      +
      +
      +

      Parameters

      +
        +
      • +
        meta: string
        +
        +

        list of key/value pairs

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Set an optional friendly name that can be used to execute a query instead of using its ID

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of the query

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNearestN

    + +
      +
    • + +
      +
      +

      Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network + round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server + handling the query to the servers in the remote datacenter is used to determine the priority.

      +
      +
      +

      Parameters

      +
        +
      • +
        nearestN: number
        +
        +

        number of nearest datacenters to query

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setPassing

    + +
      +
    • + +
      +
      +

      Specifies the behavior of the query's health check filtering. If this is set to false, the results will include + nodes with checks in the passing as well as the warning states. If this is set to true, + only nodes with checks in the passing state will be returned.

      +
      +
      +

      Parameters

      +
        +
      • +
        passing: boolean
        +
        +

        the passing flag

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setService

    + +
      +
    • + +
      +
      +

      Set the name of the service to query

      +
      +
      +

      Parameters

      +
        +
      • +
        service: string
        +
        +

        service name

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setSession

    + +
      +
    • + +
      +
      +

      Set the ID of an existing session. This provides a way to automatically remove a prepared query when + the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        session: string
        +
        +

        id of session

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTags

    + +
      +
    • + +
      +
      +

      Set a list of service tags to filter the query results. For a service to pass the tag filter + it must have all of the required tags, and none of the excluded tags (prefixed with !).

      +
      +
      +

      Parameters

      +
        +
      • +
        tags: string
        +
        +

        list of service tags

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTemplateRegexp

    + +
      +
    • + +
      +
      +

      Set regular expression which is used to extract fields from the entire name, once this template is selected.

      +
      +
      +
      see
      +

      Prepared Query Templates endpoint

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        templateRegexp: string
        +
        +

        a regular expression

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTemplateType

    + +
      +
    • + +
      +
      +

      The template type, which must be {@code name_prefix_match}. This means that the template will apply to + any query lookup with a name whose prefix matches the Name field of the template.

      +
      +
      +
      see
      +

      Prepared Query Templates endpoint

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        templateType: string
        +
        +

        the query type

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setToken

    + +
      +
    • + +
      +
      +

      Set the ACL token to use each time the query is executed. This allows queries to be executed by clients + with lesser or even no ACL Token, so this should be used with care.

      +
      +
      +

      Parameters

      +
        +
      • +
        token: string
        +
        +

        the ACL token

        +
        +
        • +
      +

      Returns PreparedQueryDefinition

      +

      reference to this, for fluency

      +
      • +
    @@ -501,44 +999,86 @@

    token

  • PreparedQueryDefinition
    • @@ -589,10 +1129,10 @@

    token

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/preparedqueryexecuteoptions.html b/docs/@vertx/consul-client/classes/preparedqueryexecuteoptions.html index ef4354d62..041c9d116 100644 --- a/docs/@vertx/consul-client/classes/preparedqueryexecuteoptions.html +++ b/docs/@vertx/consul-client/classes/preparedqueryexecuteoptions.html @@ -77,64 +77,173 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    limit

    -
    limit: number
    - -
    -
    -

    Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling.

    -
    -
    -
    param
    -

    the size of the list to the given number of nodes

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    near

    -
    near: string
    - -
    -
    -

    Set node name for sorting the list in ascending order based on the estimated round trip time from that node. - Passing {@code _agent} will use the agent's node for the sort. If this is not present, - the default behavior will shuffle the nodes randomly each time the query is executed.

    -
    -
    -
    param
    -

    the node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getLimit

    +
      +
    • getLimit(): number
      • +
    +
      +
    • + +
      +
      +

      Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getNear

    +
      +
    • getNear(): string
      • +
    +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node. + Passing {@code _agent} will use the agent's node for the sort. If this is not present, + the default behavior will shuffle the nodes randomly each time the query is executed.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setLimit

    + +
      +
    • + +
      +
      +

      Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling.

      +
      +
      +

      Parameters

      +
        +
      • +
        limit: number
        +
        +

        the size of the list to the given number of nodes

        +
        +
        • +
      +

      Returns PreparedQueryExecuteOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNear

    + +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node. + Passing {@code _agent} will use the agent's node for the sort. If this is not present, + the default behavior will shuffle the nodes randomly each time the query is executed.

      +
      +
      +

      Parameters

      +
        +
      • +
        near: string
        +
        +

        the node name

        +
        +
        • +
      +

      Returns PreparedQueryExecuteOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -222,11 +331,20 @@

    near

  • PreparedQueryExecuteOptions
    • @@ -274,10 +392,10 @@

    near

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/preparedqueryexecuteresponse.html b/docs/@vertx/consul-client/classes/preparedqueryexecuteresponse.html index 2a700b7a9..d789c5f76 100644 --- a/docs/@vertx/consul-client/classes/preparedqueryexecuteresponse.html +++ b/docs/@vertx/consul-client/classes/preparedqueryexecuteresponse.html @@ -77,135 +77,342 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    dc

    -
    dc: string
    - -
    -
    -

    Set the datacenter that ultimately provided the list of nodes

    -
    -
    -
    param
    -

    the datacenter that ultimately provided the list of nodes

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    dnsTtl

    -
    dnsTtl: string
    - -
    -
    -

    Set the TTL duration when query results are served over DNS. If this is specified, it will take precedence over any Consul agent-specific configuration.

    -
    -
    -
    param
    -

    the TTL duration

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getDc

    +
      +
    • getDc(): string
      • +
    +
      +
    • + +
      +
      +

      Set the datacenter that ultimately provided the list of nodes

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    failovers

    -
    failovers: number
    - -
    -
    -

    Set the number of remote datacenters that were queried while executing the query.

    -
    -
    -
    param
    -

    the number of remote datacenters that were queried while executing the query.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getDnsTtl

    +
      +
    • getDnsTtl(): string
      • +
    +
      +
    • + +
      +
      +

      Set the TTL duration when query results are served over DNS. If this is specified, it will take precedence over any Consul agent-specific configuration.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    nodes

    -
    nodes: ServiceEntry
    - -
    -
    -

    Set the list of healthy nodes providing the given service, as specified by the constraints of the prepared query.

    -
    -
    -
    param
    -

    the list of healthy nodes providing the given service, as specified by the constraints of the prepared query.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getFailovers

    +
      +
    • getFailovers(): number
      • +
    +
      +
    • + +
      +
      +

      Set the number of remote datacenters that were queried while executing the query.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    service

    -
    service: string
    - -
    -
    -

    Set the service name that the query was selecting. - This is useful for context in case an empty list of nodes is returned.

    -
    -
    -
    param
    -

    the service name that the query was selecting.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNodes

    + +
      +
    • + +
      +
      +

      Set the list of healthy nodes providing the given service, as specified by the constraints of the prepared query.

      +
      +
      +

      Returns ServiceEntry

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getService

    +
      +
    • getService(): string
      • +
    +
      +
    • + +
      +
      +

      Set the service name that the query was selecting. + This is useful for context in case an empty list of nodes is returned.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setDc

    + +
      +
    • + +
      +
      +

      Set the datacenter that ultimately provided the list of nodes

      +
      +
      +

      Parameters

      +
        +
      • +
        dc: string
        +
        +

        the datacenter that ultimately provided the list of nodes

        +
        +
        • +
      +

      Returns PreparedQueryExecuteResponse

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setDnsTtl

    + +
      +
    • + +
      +
      +

      Set the TTL duration when query results are served over DNS. If this is specified, it will take precedence over any Consul agent-specific configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        dnsTtl: string
        +
        +

        the TTL duration

        +
        +
        • +
      +

      Returns PreparedQueryExecuteResponse

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setFailovers

    + +
      +
    • + +
      +
      +

      Set the number of remote datacenters that were queried while executing the query.

      +
      +
      +

      Parameters

      +
        +
      • +
        failovers: number
        +
        +

        the number of remote datacenters that were queried while executing the query.

        +
        +
        • +
      +

      Returns PreparedQueryExecuteResponse

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNodes

    + +
      +
    • + +
      +
      +

      Set the list of healthy nodes providing the given service, as specified by the constraints of the prepared query.

      +
      +
      +

      Parameters

      +
        +
      • +
        nodes: ServiceEntry
        +
        +

        the list of healthy nodes providing the given service, as specified by the constraints of the prepared query.

        +
        +
        • +
      +

      Returns PreparedQueryExecuteResponse

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setService

    + +
      +
    • + +
      +
      +

      Set the service name that the query was selecting. + This is useful for context in case an empty list of nodes is returned.

      +
      +
      +

      Parameters

      +
        +
      • +
        service: string
        +
        +

        the service name that the query was selecting.

        +
        +
        • +
      +

      Returns PreparedQueryExecuteResponse

      +

      reference to this, for fluency

      +
      • +
    @@ -296,20 +503,38 @@

    service

  • PreparedQueryExecuteResponse
    • @@ -354,10 +579,10 @@

    service

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/service.html b/docs/@vertx/consul-client/classes/service.html index 1ff5c070a..83f101e55 100644 --- a/docs/@vertx/consul-client/classes/service.html +++ b/docs/@vertx/consul-client/classes/service.html @@ -77,182 +77,511 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    address

    -
    address: string
    - -
    -
    -

    Set service address

    -
    -
    -
    param
    -

    service address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Service

      +
      • +
    • + +

      Parameters

      + +

      Returns Service

      +
      • +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set ID of service

    -
    -
    -
    param
    -

    ID of service

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAddress

    +
      +
    • getAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set service address

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set service name

    -
    -
    -
    param
    -

    service name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set ID of service

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    node

    -
    node: string
    - -
    -
    -

    Set node name

    -
    -
    -
    param
    -

    node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getMeta

    +
      +
    • getMeta(): string
      • +
    +
      +
    • + +
      +
      +

      Specifies arbitrary KV metadata linked to the service instance.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    nodeAddress

    -
    nodeAddress: string
    - -
    -
    -

    Set node address

    -
    -
    -
    param
    -

    node address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set service name

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set service port

    -
    -
    -
    param
    -

    service port

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNode

    +
      +
    • getNode(): string
      • +
    +
      +
    • + +
      +
      +

      Set node name

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tags

    -
    tags: string
    - -
    -
    -

    Set list of service tags

    -
    -
    -
    param
    -

    list of service tags

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNodeAddress

    +
      +
    • getNodeAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set node address

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set service port

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTags

    +
      +
    • getTags(): string
      • +
    +
      +
    • + +
      +
      +

      Set list of service tags

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setAddress

    +
      +
    • setAddress(address: string): Service
      • +
    +
      +
    • + +
      +
      +

      Set service address

      +
      +
      +

      Parameters

      +
        +
      • +
        address: string
        +
        +

        service address

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set ID of service

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        ID of service

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setMeta

    +
      +
    • setMeta(meta: string): Service
      • +
    +
      +
    • + +
      +
      +

      Specifies arbitrary KV metadata linked to the service instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        meta: string
        +
        +

        arbitrary KV metadata

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    +
      +
    • setName(name: string): Service
      • +
    +
      +
    • + +
      +
      +

      Set service name

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        service name

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    +
      +
    • setNode(node: string): Service
      • +
    +
      +
    • + +
      +
      +

      Set node name

      +
      +
      +

      Parameters

      +
        +
      • +
        node: string
        +
        +

        node name

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNodeAddress

    +
      +
    • setNodeAddress(nodeAddress: string): Service
      • +
    +
      +
    • + +
      +
      +

      Set node address

      +
      +
      +

      Parameters

      +
        +
      • +
        nodeAddress: string
        +
        +

        node address

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setPort

    +
      +
    • setPort(port: number): Service
      • +
    +
      +
    • + +
      +
      +

      Set service port

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        service port

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTags

    +
      +
    • setTags(tags: string): Service
      • +
    +
      +
    • + +
      +
      +

      Set list of service tags

      +
      +
      +

      Parameters

      +
        +
      • +
        tags: string
        +
        +

        list of service tags

        +
        +
        • +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    @@ -346,26 +675,56 @@

    tags

  • Service
    • @@ -407,10 +766,10 @@

    tags

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/serviceentry.html b/docs/@vertx/consul-client/classes/serviceentry.html index 97260cdc9..80e213a35 100644 --- a/docs/@vertx/consul-client/classes/serviceentry.html +++ b/docs/@vertx/consul-client/classes/serviceentry.html @@ -77,86 +77,226 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    checks

    -
    checks: Check
    - -
    -
    -

    Set list of checks

    -
    -
    -
    param
    -

    list of checks

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    node

    -
    node: Node
    - -
    -
    -

    Set node

    -
    -
    -
    param
    -

    node

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getChecks

    + +
      +
    • + +
      +
      +

      Set list of checks

      +
      +
      +

      Returns Check

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    service

    -
    service: Service
    - -
    -
    -

    Set service

    -
    -
    -
    param
    -

    service

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNode

    +
      +
    • getNode(): Node
      • +
    +
      +
    • + +
      +
      +

      Set node

      +
      +
      +

      Returns Node

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getService

    + +
      +
    • + +
      +
      +

      Set service

      +
      +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setChecks

    + +
      +
    • + +
      +
      +

      Set list of checks

      +
      +
      +

      Parameters

      +
        +
      • +
        checks: Check
        +
        +

        list of checks

        +
        +
        • +
      +

      Returns ServiceEntry

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    + +
      +
    • + +
      +
      +

      Set node

      +
      +
      +

      Parameters

      +
        +
      • +
        node: Node
        +
        +

        node

        +
        +
        • +
      +

      Returns ServiceEntry

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setService

    + +
      +
    • + +
      +
      +

      Set service

      +
      +
      +

      Parameters

      +
        +
      • +
        service: Service
        +
        +

        service

        +
        +
        • +
      +

      Returns ServiceEntry

      +

      reference to this, for fluency

      +
      • +
    @@ -253,14 +393,26 @@

    service

  • ServiceEntry
    • @@ -299,10 +451,10 @@

    service

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/serviceentrylist.html b/docs/@vertx/consul-client/classes/serviceentrylist.html index 32d12c482..341fe2119 100644 --- a/docs/@vertx/consul-client/classes/serviceentrylist.html +++ b/docs/@vertx/consul-client/classes/serviceentrylist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested list of services

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    list

    -
    list: ServiceEntry
    - -
    -
    -

    Set list of services

    -
    -
    -
    param
    -

    list of services

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of services

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of services

      +
      +
      +

      Returns ServiceEntry

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of services

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns ServiceEntryList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of services

      +
      +
      +

      Parameters

      + +

      Returns ServiceEntryList

      +

      reference to this, for fluency

      +
      • +
    @@ -232,11 +339,20 @@

    list

  • ServiceEntryList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/servicelist.html b/docs/@vertx/consul-client/classes/servicelist.html index 2e9b3b18a..aa49da5bf 100644 --- a/docs/@vertx/consul-client/classes/servicelist.html +++ b/docs/@vertx/consul-client/classes/servicelist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested list of services

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns ServiceList

      +
      • +
    • + +

      Parameters

      + +

      Returns ServiceList

      +
      • +
    -
    - -

    list

    -
    list: Service
    - -
    -
    -

    Set list of services

    -
    -
    -
    param
    -

    the list of services

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of services

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of services

      +
      +
      +

      Returns Service

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of services

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns ServiceList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of services

      +
      +
      +

      Parameters

      +
        +
      • +
        list: Service
        +
        +

        the list of services

        +
        +
        • +
      +

      Returns ServiceList

      +

      reference to this, for fluency

      +
      • +
    @@ -235,11 +342,20 @@

    list

  • ServiceList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/serviceoptions.html b/docs/@vertx/consul-client/classes/serviceoptions.html index 1e39fa10f..96adc5a10 100644 --- a/docs/@vertx/consul-client/classes/serviceoptions.html +++ b/docs/@vertx/consul-client/classes/serviceoptions.html @@ -77,158 +77,454 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    address

    -
    address: string
    - -
    -
    -

    Set service address

    -
    -
    -
    param
    -

    service address

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    checkOptions

    -
    checkOptions: CheckOptions
    - -
    -
    -

    Set check options of service

    -
    -
    -
    param
    -

    check options

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAddress

    +
      +
    • getAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set service address

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set the ID of session

    -
    -
    -
    param
    -

    the ID of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getCheckOptions

    + +
      +
    • + +
      +
      +

      Set check options of service

      +
      +
      +

      Returns CheckOptions

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set service name

    -
    -
    -
    param
    -

    service name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of session

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set service port

    -
    -
    -
    param
    -

    service port

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getMeta

    +
      +
    • getMeta(): string
      • +
    +
      +
    • + +
      +
      +

      Specifies arbitrary KV metadata linked to the service instance.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tags

    -
    tags: string
    - -
    -
    -

    Set list of tags associated with service

    -
    -
    -
    param
    -

    list of tags

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set service name

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set service port

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTags

    +
      +
    • getTags(): string
      • +
    +
      +
    • + +
      +
      +

      Set list of tags associated with service

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setAddress

    + +
      +
    • + +
      +
      +

      Set service address

      +
      +
      +

      Parameters

      +
        +
      • +
        address: string
        +
        +

        service address

        +
        +
        • +
      +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setCheckOptions

    + +
      +
    • + +
      +
      +

      Set check options of service

      +
      +
      +

      Parameters

      + +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set the ID of session

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the ID of session

        +
        +
        • +
      +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setMeta

    + +
      +
    • + +
      +
      +

      Specifies arbitrary KV metadata linked to the service instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        meta: string
        +
        +

        arbitrary KV metadata

        +
        +
        • +
      +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Set service name

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        service name

        +
        +
        • +
      +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set service port

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        service port

        +
        +
        • +
      +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTags

    + +
      +
    • + +
      +
      +

      Set list of tags associated with service

      +
      +
      +

      Parameters

      +
        +
      • +
        tags: string
        +
        +

        list of tags

        +
        +
        • +
      +

      Returns ServiceOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -334,23 +630,50 @@

    tags

  • ServiceOptions
    • @@ -380,10 +703,10 @@

    tags

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/servicequeryoptions.html b/docs/@vertx/consul-client/classes/servicequeryoptions.html index cc5c428da..69f13520e 100644 --- a/docs/@vertx/consul-client/classes/servicequeryoptions.html +++ b/docs/@vertx/consul-client/classes/servicequeryoptions.html @@ -77,86 +77,223 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    blockingOptions

    -
    blockingOptions: BlockingQueryOptions
    - -
    -
    -

    Set options for blocking query

    -
    -
    -
    param
    -

    the blocking options

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    near

    -
    near: string
    - -
    -
    -

    Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

    -
    -
    -
    param
    -

    the node name

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Returns BlockingQueryOptions

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    tag

    -
    tag: string
    - -
    -
    -

    Set tag for filtering request results

    -
    -
    -
    param
    -

    the tag

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNear

    +
      +
    • getNear(): string
      • +
    +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTag

    +
      +
    • getTag(): string
      • +
    +
      +
    • + +
      +
      +

      Set tag for filtering request results

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setBlockingOptions

    + +
      +
    • + +
      +
      +

      Set options for blocking query

      +
      +
      +

      Parameters

      + +

      Returns ServiceQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNear

    + +
      +
    • + +
      +
      +

      Set node name for sorting the list in ascending order based on the estimated round trip time from that node.

      +
      +
      +

      Parameters

      +
        +
      • +
        near: string
        +
        +

        the node name

        +
        +
        • +
      +

      Returns ServiceQueryOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTag

    + +
      +
    • + +
      +
      +

      Set tag for filtering request results

      +
      +
      +

      Parameters

      +
        +
      • +
        tag: string
        +
        +

        the tag

        +
        +
        • +
      +

      Returns ServiceQueryOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -265,14 +402,26 @@

    tag

  • ServiceQueryOptions
    • @@ -299,10 +448,10 @@

    tag

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/session.html b/docs/@vertx/consul-client/classes/session.html index c4687d8fb..af17ea36c 100644 --- a/docs/@vertx/consul-client/classes/session.html +++ b/docs/@vertx/consul-client/classes/session.html @@ -77,158 +77,397 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    checks

    -
    checks: string
    - -
    -
    -

    Set the list of associated health checks

    -
    -
    -
    param
    -

    the list of associated health checks

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Session

      +
      • +
    • + +

      Parameters

      + +

      Returns Session

      +
      • +
    -
    - -

    createIndex

    -
    createIndex: number
    - -
    -
    -

    Set the create index of session

    -
    -
    -
    param
    -

    the create index of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getChecks

    +
      +
    • getChecks(): string
      • +
    +
      +
    • + +
      +
      +

      Set the list of associated health checks

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set the ID of node

    -
    -
    -
    param
    -

    the ID of node

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getCreateIndex

    +
      +
    • getCreateIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the create index of session

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of node

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    lockDelay

    -
    lockDelay: number
    - -
    -
    -

    Set the Lock delay of session

    -
    -
    -
    param
    -

    the Lock delay of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    node

    -
    node: string
    - -
    -
    -

    Set the ID of node

    -
    -
    -
    param
    -

    the ID of node

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getLockDelay

    +
      +
    • getLockDelay(): number
      • +
    +
      +
    • + +
      +
      +

      Set the Lock delay of session

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getNode

    +
      +
    • getNode(): string
      • +
    +
      +
    • + +
      +
      +

      Set the ID of node

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setChecks

    +
      +
    • setChecks(checks: string): Session
      • +
    +
      +
    • + +
      +
      +

      Set the list of associated health checks

      +
      +
      +

      Parameters

      +
        +
      • +
        checks: string
        +
        +

        the list of associated health checks

        +
        +
        • +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setCreateIndex

    +
      +
    • setCreateIndex(createIndex: number): Session
      • +
    +
      +
    • + +
      +
      +

      Set the create index of session

      +
      +
      +

      Parameters

      +
        +
      • +
        createIndex: number
        +
        +

        the create index of session

        +
        +
        • +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set the ID of node

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        +

        the ID of node

        +
        +
        • +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    +
      +
    • setIndex(index: number): Session
      • +
    +
      +
    • + +
      +
      +

      Set Consul index

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setLockDelay

    +
      +
    • setLockDelay(lockDelay: number): Session
      • +
    +
      +
    • + +
      +
      +

      Set the Lock delay of session

      +
      +
      +

      Parameters

      +
        +
      • +
        lockDelay: number
        +
        +

        the Lock delay of session

        +
        +
        • +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    +
      +
    • setNode(node: string): Session
      • +
    +
      +
    • + +
      +
      +

      Set the ID of node

      +
      +
      +

      Parameters

      +
        +
      • +
        node: string
        +
        +

        the ID of node

        +
        +
        • +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    @@ -340,23 +579,44 @@

    node

  • Session
    • @@ -380,10 +640,10 @@

    node

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/sessionlist.html b/docs/@vertx/consul-client/classes/sessionlist.html index b82bec2d7..144c7045d 100644 --- a/docs/@vertx/consul-client/classes/sessionlist.html +++ b/docs/@vertx/consul-client/classes/sessionlist.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set Consul index, a unique identifier representing the current state of the requested list of sessions

    -
    -
    -
    param
    -

    the consul index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns SessionList

      +
      • +
    • + +

      Parameters

      + +

      Returns SessionList

      +
      • +
    -
    - -

    list

    -
    list: Session
    - -
    -
    -

    Set list of sessions

    -
    -
    -
    param
    -

    the list of sessions

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of sessions

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getList

    + +
      +
    • + +
      +
      +

      Set list of sessions

      +
      +
      +

      Returns Session

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set Consul index, a unique identifier representing the current state of the requested list of sessions

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the consul index

        +
        +
        • +
      +

      Returns SessionList

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setList

    + +
      +
    • + +
      +
      +

      Set list of sessions

      +
      +
      +

      Parameters

      +
        +
      • +
        list: Session
        +
        +

        the list of sessions

        +
        +
        • +
      +

      Returns SessionList

      +

      reference to this, for fluency

      +
      • +
    @@ -247,11 +354,20 @@

    list

  • SessionList
    • @@ -272,10 +388,10 @@

    list

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/sessionoptions.html b/docs/@vertx/consul-client/classes/sessionoptions.html index f48e75309..c539e0c18 100644 --- a/docs/@vertx/consul-client/classes/sessionoptions.html +++ b/docs/@vertx/consul-client/classes/sessionoptions.html @@ -77,169 +77,423 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    behavior

    -
    behavior: SessionBehavior
    - -
    -
    -

    Set the behavior when a session is invalidated. The release behavior is the default if none is specified.

    -
    -
    -
    param
    -

    the session behavior

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    checks

    -
    checks: string
    - -
    -
    -

    Set a list of associated health checks. It is highly recommended that, - if you override this list, you include the default "serfHealth"

    -
    -
    -
    param
    -

    list of associated health checks

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getBehavior

    +
      +
    • getBehavior(): SessionBehavior
      • +
    +
      +
    • + +
      +
      +

      Set the behavior when a session is invalidated. The release behavior is the default if none is specified.

      +
      +
      +

      Returns SessionBehavior

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    lockDelay

    -
    lockDelay: number
    - -
    -
    -

    Set the lock-delay period.

    -
    -
    -
    param
    -

    the lock-delay period in seconds

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    see
    -

    Session#getLockDelay()

    -
    -
    -
    +
    + +

    getChecks

    +
      +
    • getChecks(): string
      • +
    +
      +
    • + +
      +
      +

      Set a list of associated health checks. It is highly recommended that, + if you override this list, you include the default "serfHealth"

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Set the human-readable name for the Session

    -
    -
    -
    param
    -

    the name of session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getLockDelay

    +
      +
    • getLockDelay(): number
      • +
    +
      +
    • + +
      +
      +

      Set the lock-delay period.

      +
      +
      +
      see
      +

      Session#getLockDelay()

      +
      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    node

    -
    node: string
    - -
    -
    -

    Set the node to which the session will be assigned

    -
    -
    -
    param
    -

    the ID of node

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the human-readable name for the Session

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    ttl

    -
    ttl: number
    - -
    -
    -

    Set the TTL interval. When TTL interval expires without being renewed, the session has expired - and an invalidation is triggered. If specified, it must be between {@code 10s} and {@code 86400s} currently.

    -
    -

    The contract of a TTL is that it represents a lower bound for invalidation; that is, - Consul will not expire the session before the TTL is reached, but it is allowed to delay - the expiration past the TTL.

    -

    The lowest practical TTL should be used to keep the number of managed sessions low. - When locks are forcibly expired, such as during a leader election, sessions may not be reaped for - up to double this TTL, so long TTL values (> 1 hour) should be avoided.

    -
    -
    param
    -

    the TTL interval in seconds

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getNode

    +
      +
    • getNode(): string
      • +
    +
      +
    • + +
      +
      +

      Set the node to which the session will be assigned

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getTtl

    +
      +
    • getTtl(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TTL interval. When TTL interval expires without being renewed, the session has expired + and an invalidation is triggered. If specified, it must be between {@code 10s} and {@code 86400s} currently.

      +
      +

      The contract of a TTL is that it represents a lower bound for invalidation; that is, + Consul will not expire the session before the TTL is reached, but it is allowed to delay + the expiration past the TTL.

      +

      The lowest practical TTL should be used to keep the number of managed sessions low. + When locks are forcibly expired, such as during a leader election, sessions may not be reaped for + up to double this TTL, so long TTL values (> 1 hour) should be avoided.

      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setBehavior

    + +
      +
    • + +
      +
      +

      Set the behavior when a session is invalidated. The release behavior is the default if none is specified.

      +
      +
      +

      Parameters

      +
        +
      • +
        behavior: SessionBehavior
        +
        +

        the session behavior

        +
        +
        • +
      +

      Returns SessionOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setChecks

    + +
      +
    • + +
      +
      +

      Set a list of associated health checks. It is highly recommended that, + if you override this list, you include the default "serfHealth"

      +
      +
      +

      Parameters

      +
        +
      • +
        checks: string
        +
        +

        list of associated health checks

        +
        +
        • +
      +

      Returns SessionOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setLockDelay

    + +
      +
    • + +
      +
      +

      Set the lock-delay period.

      +
      +
      +
      see
      +

      Session#getLockDelay()

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        lockDelay: number
        +
        +

        the lock-delay period in seconds

        +
        +
        • +
      +

      Returns SessionOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Set the human-readable name for the Session

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        the name of session

        +
        +
        • +
      +

      Returns SessionOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setNode

    + +
      +
    • + +
      +
      +

      Set the node to which the session will be assigned

      +
      +
      +

      Parameters

      +
        +
      • +
        node: string
        +
        +

        the ID of node

        +
        +
        • +
      +

      Returns SessionOptions

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setTtl

    + +
      +
    • + +
      +
      +

      Set the TTL interval. When TTL interval expires without being renewed, the session has expired + and an invalidation is triggered. If specified, it must be between {@code 10s} and {@code 86400s} currently.

      +
      +

      The contract of a TTL is that it represents a lower bound for invalidation; that is, + Consul will not expire the session before the TTL is reached, but it is allowed to delay + the expiration past the TTL.

      +

      The lowest practical TTL should be used to keep the number of managed sessions low. + When locks are forcibly expired, such as during a leader election, sessions may not be reaped for + up to double this TTL, so long TTL values (> 1 hour) should be avoided.

      +
      +

      Parameters

      +
        +
      • +
        ttl: number
        +
        +

        the TTL interval in seconds

        +
        +
        • +
      +

      Returns SessionOptions

      +

      reference to this, for fluency

      +
      • +
    @@ -357,23 +611,44 @@

    ttl

  • SessionOptions
    • @@ -391,10 +666,10 @@

    ttl

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/txnerror.html b/docs/@vertx/consul-client/classes/txnerror.html index 5db2891f0..6f3af983e 100644 --- a/docs/@vertx/consul-client/classes/txnerror.html +++ b/docs/@vertx/consul-client/classes/txnerror.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    opIndex

    -
    opIndex: number
    - -
    -
    -

    Set the index of the failed operation in the transaction

    -
    -
    -
    param
    -

    the index of the failed operation in the transaction

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns TxnError

      +
      • +
    • + +

      Parameters

      + +

      Returns TxnError

      +
      • +
    -
    - -

    what

    -
    what: string
    - -
    -
    -

    Set error message about why that operation failed.

    -
    -
    -
    param
    -

    error message about why that operation failed.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getOpIndex

    +
      +
    • getOpIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the index of the failed operation in the transaction

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getWhat

    +
      +
    • getWhat(): string
      • +
    +
      +
    • + +
      +
      +

      Set error message about why that operation failed.

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setOpIndex

    +
      +
    • setOpIndex(opIndex: number): TxnError
      • +
    +
      +
    • + +
      +
      +

      Set the index of the failed operation in the transaction

      +
      +
      +

      Parameters

      +
        +
      • +
        opIndex: number
        +
        +

        the index of the failed operation in the transaction

        +
        +
        • +
      +

      Returns TxnError

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setWhat

    + +
      +
    • + +
      +
      +

      Set error message about why that operation failed.

      +
      +
      +

      Parameters

      +
        +
      • +
        what: string
        +
        +

        error message about why that operation failed.

        +
        +
        • +
      +

      Returns TxnError

      +

      reference to this, for fluency

      +
      • +
    @@ -253,11 +360,20 @@

    what

  • TxnError
    • @@ -272,10 +388,10 @@

    what

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/txnkvoperation.html b/docs/@vertx/consul-client/classes/txnkvoperation.html index 6ac475aa1..bf62cc8cd 100644 --- a/docs/@vertx/consul-client/classes/txnkvoperation.html +++ b/docs/@vertx/consul-client/classes/txnkvoperation.html @@ -77,164 +77,417 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    flags

    -
    flags: number
    - -
    -
    -

    Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

    -
    -
    -
    param
    -

    the flags attached to this entry. Clients can choose to use this however makes sense for their application.

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Set the index used for locking, unlocking, and check-and-set operations.

    -
    -
    -
    param
    -

    the index

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    see
    -

    /v1/txn endpoint

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getFlags

    +
      +
    • getFlags(): number
      • +
    +
      +
    • + +
      +
      +

      Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    key

    -
    key: string
    - -
    -
    -

    Set the key

    -
    -
    -
    param
    -

    the key

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Set the index used for locking, unlocking, and check-and-set operations.

      +
      +
      +
      see
      +

      /v1/txn endpoint

      +
      +
      +
      +

      Returns number

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    session

    -
    session: string
    - -
    -
    -

    Set the session used for locking, unlocking, and check-and-set operations.

    -
    -
    -
    param
    -

    the session

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    see
    -

    /v1/txn endpoint

    -
    -
    -
    +
    + +

    getKey

    +
      +
    • getKey(): string
      • +
    +
      +
    • + +
      +
      +

      Set the key

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    type

    -
    type: TxnKVVerb
    - -
    -
    -

    Set the type of operation to perform

    -
    -
    -
    param
    -

    the type of operation to perform

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getSession

    +
      +
    • getSession(): string
      • +
    +
      +
    • + +
      +
      +

      Set the session used for locking, unlocking, and check-and-set operations.

      +
      +
      +
      see
      +

      /v1/txn endpoint

      +
      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    -
    - -

    value

    -
    value: string
    - -
    -
    -

    Set the value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    getType

    +
      +
    • getType(): TxnKVVerb
      • +
    +
      +
    • + +
      +
      +

      Set the type of operation to perform

      +
      +
      +

      Returns TxnKVVerb

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getValue

    +
      +
    • getValue(): string
      • +
    +
      +
    • + +
      +
      +

      Set the value

      +
      +
      +

      Returns string

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setFlags

    + +
      +
    • + +
      +
      +

      Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

      +
      +
      +

      Parameters

      +
        +
      • +
        flags: number
        +
        +

        the flags attached to this entry. Clients can choose to use this however makes sense for their application.

        +
        +
        • +
      +

      Returns TxnKVOperation

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Set the index used for locking, unlocking, and check-and-set operations.

      +
      +
      +
      see
      +

      /v1/txn endpoint

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the index

        +
        +
        • +
      +

      Returns TxnKVOperation

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setKey

    + +
      +
    • + +
      +
      +

      Set the key

      +
      +
      +

      Parameters

      +
        +
      • +
        key: string
        +
        +

        the key

        +
        +
        • +
      +

      Returns TxnKVOperation

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setSession

    + +
      +
    • + +
      +
      +

      Set the session used for locking, unlocking, and check-and-set operations.

      +
      +
      +
      see
      +

      /v1/txn endpoint

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        session: string
        +
        +

        the session

        +
        +
        • +
      +

      Returns TxnKVOperation

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +
      +
      +

      Set the type of operation to perform

      +
      +
      +

      Parameters

      +
        +
      • +
        type: TxnKVVerb
        +
        +

        the type of operation to perform

        +
        +
        • +
      +

      Returns TxnKVOperation

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    setValue

    + +
      +
    • + +
      +
      +

      Set the value

      +
      +
      +

      Parameters

      +
        +
      • +
        value: string
        +
        +

        the value

        +
        +
        • +
      +

      Returns TxnKVOperation

      +

      reference to this, for fluency

      +
      • +
    @@ -358,23 +611,44 @@

    value

  • TxnKVOperation
    • @@ -386,10 +660,10 @@

    value

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/classes/txnrequest.html b/docs/@vertx/consul-client/classes/txnrequest.html index c5d98572c..245e78569 100644 --- a/docs/@vertx/consul-client/classes/txnrequest.html +++ b/docs/@vertx/consul-client/classes/txnrequest.html @@ -72,6 +72,86 @@

    Hierarchy

    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns TxnRequest

      +
      • +
    • + +

      Parameters

      + +

      Returns TxnRequest

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    getOperationsSize

    +
      +
    • getOperationsSize(): number
      • +
    +
      +
    • + +
      +
      +

      Returns the number of operations in this request

      +
      +
      +

      Returns number

      +

      the number of operations in this request

      +
      • +
    +
    +
    -

    Properties

    -
    - -

    errors

    -
    errors: TxnError
    - -
    -
    -

    Adds error to this response

    -
    -
    -
    param
    -

    the error

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns TxnResponse

      +
      • +
    • + +

      Parameters

      + +

      Returns TxnResponse

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addError

    + +
      +
    • + +
      +
      +

      Adds error to this response

      +
      +
      +

      Parameters

      + +

      Returns TxnResponse

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getErrors

    + +
      +
    • + +
      +
      +

      Adds error to this response

      +
      +
      +

      Returns TxnError

      +

      reference to this, for fluency

      +
      • +
    +
    +
    + +

    getErrorsSize

    +
      +
    • getErrorsSize(): number
      • +
    +
      +
    • + +
      +
      +

      Returns the number of errors in this response

      +
      +
      +

      Returns number

      +

      the number of errors in this response

      +
      • +
    +
    +
    + +

    getResultsSize

    +
      +
    • getResultsSize(): number
      • +
    +
      +
    • + +
      +
      +

      Returns the number of results in this response

      +
      +
      +

      Returns number

      +

      the number of results in this response

      +
      • +
    @@ -238,17 +357,29 @@

    errors

  • TxnResponse
    • diff --git a/docs/@vertx/consul-client/classes/watch.html b/docs/@vertx/consul-client/classes/watch.html index 9c96abd83..aa27e94ff 100644 --- a/docs/@vertx/consul-client/classes/watch.html +++ b/docs/@vertx/consul-client/classes/watch.html @@ -57,13 +57,21 @@ Watch -

    Class Watch

    +

    Class Watch<T>

    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Hierarchy

      @@ -99,18 +107,18 @@

      Methods

      setHandler

        -
      • setHandler(handler: function): Watch
        • +
      • setHandler(handler: function): Watch<T>
      • -

        Set the result handler. As data is changed, the handler will be called with the result.

        +

        Set the result handler. As data is changed, the handler will be called with the result.

        Parameters

        @@ -123,24 +131,27 @@
        handler: function
      -

      Returns Watch

      +

      Returns Watch<T>

      reference to this, for fluency

    @@ -149,21 +160,21 @@

    Returns

    start

    • -

      Start this {@code Watch}

      +

      Start this {@code Watch}

      -

      Returns Watch

      +

      Returns Watch<T>

      reference to this, for fluency

    @@ -178,12 +189,12 @@

    stop

  • -

    Stop the watch and release its resources

    +

    Stop the watch and release its resources

    Returns void

    @@ -194,19 +205,19 @@

    Returns void

    Static events

    • -

      Creates {@code Watch} to monitoring the custom user events. +

      Creates {@code Watch} to monitoring the custom user events. The underlying Consul client will be created with default options. This maps to the /v1/event/list API internally.

      @@ -226,18 +237,18 @@
      vertx: Vertx
    -

    Returns Watch

    +

    Returns Watch<EventList>

    the {@code Watch} instance

  • -

    Creates {@code Watch} to monitoring the custom user events. +

    Creates {@code Watch} to monitoring the custom user events. This maps to the /v1/event/list API internally.

    @@ -262,7 +273,7 @@
    options: Consu
    • -

    Returns Watch

    +

    Returns Watch<EventList>

    the {@code Watch} instance

    @@ -271,19 +282,19 @@

    Returns

    Static key

    • -

      Creates {@code Watch} to monitoring a specific key in the KV store. +

      Creates {@code Watch} to monitoring a specific key in the KV store. The underlying Consul client will be created with default options. This maps to the /v1/kv/ API internally.

      @@ -303,18 +314,18 @@
      vertx: Vertx
    -

    Returns Watch

    +

    Returns Watch<KeyValue>

    the {@code Watch} instance

  • -

    Creates {@code Watch} to monitoring a specific key in the KV store. +

    Creates {@code Watch} to monitoring a specific key in the KV store. This maps to the /v1/kv/ API internally.

    @@ -339,7 +350,7 @@
    options: Consu
    • -

    Returns Watch

    +

    Returns Watch<KeyValue>

    the {@code Watch} instance

    @@ -348,19 +359,19 @@

    Returns

    Static keyPrefix

    • -

      Creates {@code Watch} to monitoring a prefix of keys in the KV store. +

      Creates {@code Watch} to monitoring a prefix of keys in the KV store. The underlying Consul client will be created with default options. This maps to the /v1/kv/ API internally.

      @@ -380,18 +391,18 @@
      vertx: Vertx
    -

    Returns Watch

    +

    Returns Watch<KeyValueList>

    the {@code Watch} instance

  • -

    Creates {@code Watch} to monitoring a prefix of keys in the KV store. +

    Creates {@code Watch} to monitoring a prefix of keys in the KV store. This maps to the /v1/kv/ API internally.

    @@ -416,7 +427,7 @@
    options: Consu
    • -

    Returns Watch

    +

    Returns Watch<KeyValueList>

    the {@code Watch} instance

    @@ -425,19 +436,19 @@

    Returns

    Static nodes

    • -

      Creates {@code Watch} to monitoring the list of available nodes. +

      Creates {@code Watch} to monitoring the list of available nodes. The underlying Consul client will be created with default options. This maps to the /v1/catalog/nodes API internally.

      @@ -451,18 +462,18 @@
      vertx: Vertx
    -

    Returns Watch

    +

    Returns Watch<NodeList>

    the {@code Watch} instance

  • -

    Creates {@code Watch} to monitoring the list of available nodes. +

    Creates {@code Watch} to monitoring the list of available nodes. This maps to the /v1/catalog/nodes API internally.

    @@ -481,7 +492,7 @@
    options: Consu
    • -

    Returns Watch

    +

    Returns Watch<NodeList>

    the {@code Watch} instance

    @@ -490,19 +501,19 @@

    Returns

    Static service

    • -

      Creates {@code Watch} to monitoring the nodes providing the service. +

      Creates {@code Watch} to monitoring the nodes providing the service. The underlying Consul client will be created with default options. This maps to the /v1/health/service/<service> API internally.

      @@ -522,18 +533,18 @@
      vertx: Vertx
    -

    Returns Watch

    +

    Returns Watch<ServiceEntryList>

    the {@code Watch} instance

  • -

    Creates {@code Watch} to monitoring the nodes providing the service. +

    Creates {@code Watch} to monitoring the nodes providing the service. This maps to the /v1/health/service/<service> API internally.

    @@ -558,7 +569,7 @@
    options: Consu
    • -

    Returns Watch

    +

    Returns Watch<ServiceEntryList>

    the {@code Watch} instance

    @@ -567,19 +578,19 @@

    Returns

    Static services

    • -

      Creates {@code Watch} to monitoring the list of available services. +

      Creates {@code Watch} to monitoring the list of available services. The underlying Consul client will be created with default options. This maps to the /v1/catalog/services API internally.

      @@ -593,18 +604,18 @@
      vertx: Vertx
    -

    Returns Watch

    +

    Returns Watch<ServiceList>

    the {@code Watch} instance

  • -

    Creates {@code Watch} to monitoring the list of available services. +

    Creates {@code Watch} to monitoring the list of available services. This maps to the /v1/catalog/services API internally.

    @@ -623,7 +634,7 @@
    options: Consu
    • -

    Returns Watch

    +

    Returns Watch<ServiceList>

    the {@code Watch} instance

    @@ -756,7 +767,7 @@

    Returns -
  • +
  • Watch diff --git a/docs/@vertx/consul-client/classes/watchresult.html b/docs/@vertx/consul-client/classes/watchresult.html index 1cd34e264..982f388f6 100644 --- a/docs/@vertx/consul-client/classes/watchresult.html +++ b/docs/@vertx/consul-client/classes/watchresult.html @@ -57,13 +57,21 @@ WatchResult
    • -

    Class WatchResult

    +

    Class WatchResult<T>

    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Hierarchy

      @@ -101,12 +109,12 @@

      cause

    • -

      A Throwable describing failure. This will be null if the operation succeeded.

      +

      A Throwable describing failure. This will be null if the operation succeeded.

      Returns Error

      @@ -124,12 +132,12 @@

      failed

    • -

      Did it fail?

      +

      Did it fail?

      Returns boolean

      @@ -141,21 +149,21 @@

      Returns boolean

      nextResult

        -
      • nextResult(): Object
        • +
      • nextResult(): T
      • -

        The next result of the operation. This will be null if the operation failed.

        +

        The next result of the operation. This will be null if the operation failed.

        -

        Returns Object

        +

        Returns T

        the next result or null if the operation failed.

      @@ -164,21 +172,21 @@

      Returns Object

      prevResult

        -
      • prevResult(): Object
        • +
      • prevResult(): T
      • -

        The previous result of the operation.

        +

        The previous result of the operation.

        -

        Returns Object

        +

        Returns T

        the previous result.

      @@ -193,12 +201,12 @@

      succeeded

    • -

      Did it succeed?

      +

      Did it succeed?

      Returns boolean

      @@ -332,12 +340,12 @@

      Returns boolean TxnResponse

      • -
    • +
    • Watch

    @@ -238,10 +238,10 @@

    Classes

  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/consul-client/index.html b/docs/@vertx/consul-client/index.html index a130108af..e33b37c84 100644 --- a/docs/@vertx/consul-client/index.html +++ b/docs/@vertx/consul-client/index.html @@ -221,10 +221,10 @@
  • TxnResponse
    • -
  • +
  • Watch
    • -
  • +
  • WatchResult
    • diff --git a/docs/@vertx/core/assets/js/search.js b/docs/@vertx/core/assets/js/search.js index ed89e9c28..df2a9e651 100644 --- a/docs/@vertx/core/assets/js/search.js +++ b/docs/@vertx/core/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"2":"Module","4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","1024":"Property","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":4,"name":"ClientAuth","url":"enums/clientauth.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"NONE","url":"enums/clientauth.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ClientAuth"},{"id":2,"kind":16,"name":"REQUEST","url":"enums/clientauth.html#request","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ClientAuth"},{"id":3,"kind":16,"name":"REQUIRED","url":"enums/clientauth.html#required","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ClientAuth"},{"id":4,"kind":4,"name":"DnsResponseCode","url":"enums/dnsresponsecode.html","classes":"tsd-kind-enum"},{"id":5,"kind":16,"name":"NOERROR","url":"enums/dnsresponsecode.html#noerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":6,"kind":16,"name":"FORMERROR","url":"enums/dnsresponsecode.html#formerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":7,"kind":16,"name":"SERVFAIL","url":"enums/dnsresponsecode.html#servfail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":8,"kind":16,"name":"NXDOMAIN","url":"enums/dnsresponsecode.html#nxdomain","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":9,"kind":16,"name":"NOTIMPL","url":"enums/dnsresponsecode.html#notimpl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":10,"kind":16,"name":"REFUSED","url":"enums/dnsresponsecode.html#refused","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":11,"kind":16,"name":"YXDOMAIN","url":"enums/dnsresponsecode.html#yxdomain","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":12,"kind":16,"name":"YXRRSET","url":"enums/dnsresponsecode.html#yxrrset","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":13,"kind":16,"name":"NXRRSET","url":"enums/dnsresponsecode.html#nxrrset","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":14,"kind":16,"name":"NOTAUTH","url":"enums/dnsresponsecode.html#notauth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":15,"kind":16,"name":"NOTZONE","url":"enums/dnsresponsecode.html#notzone","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":16,"kind":16,"name":"BADVERS","url":"enums/dnsresponsecode.html#badvers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":17,"kind":16,"name":"BADSIG","url":"enums/dnsresponsecode.html#badsig","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":18,"kind":16,"name":"BADKEY","url":"enums/dnsresponsecode.html#badkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":19,"kind":16,"name":"BADTIME","url":"enums/dnsresponsecode.html#badtime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":20,"kind":4,"name":"HttpMethod","url":"enums/httpmethod.html","classes":"tsd-kind-enum"},{"id":21,"kind":16,"name":"OPTIONS","url":"enums/httpmethod.html#options","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":22,"kind":16,"name":"GET","url":"enums/httpmethod.html#get","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":23,"kind":16,"name":"HEAD","url":"enums/httpmethod.html#head","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":24,"kind":16,"name":"POST","url":"enums/httpmethod.html#post","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":25,"kind":16,"name":"PUT","url":"enums/httpmethod.html#put","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":26,"kind":16,"name":"DELETE","url":"enums/httpmethod.html#delete","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":27,"kind":16,"name":"TRACE","url":"enums/httpmethod.html#trace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":28,"kind":16,"name":"CONNECT","url":"enums/httpmethod.html#connect","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":29,"kind":16,"name":"PATCH","url":"enums/httpmethod.html#patch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":30,"kind":16,"name":"OTHER","url":"enums/httpmethod.html#other","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":31,"kind":4,"name":"HttpVersion","url":"enums/httpversion.html","classes":"tsd-kind-enum"},{"id":32,"kind":16,"name":"HTTP_1_0","url":"enums/httpversion.html#http_1_0","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpVersion"},{"id":33,"kind":16,"name":"HTTP_1_1","url":"enums/httpversion.html#http_1_1","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpVersion"},{"id":34,"kind":16,"name":"HTTP_2","url":"enums/httpversion.html#http_2","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpVersion"},{"id":35,"kind":4,"name":"JsonEventType","url":"enums/jsoneventtype.html","classes":"tsd-kind-enum"},{"id":36,"kind":16,"name":"START_OBJECT","url":"enums/jsoneventtype.html#start_object","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":37,"kind":16,"name":"END_OBJECT","url":"enums/jsoneventtype.html#end_object","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":38,"kind":16,"name":"START_ARRAY","url":"enums/jsoneventtype.html#start_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":39,"kind":16,"name":"END_ARRAY","url":"enums/jsoneventtype.html#end_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":40,"kind":16,"name":"VALUE","url":"enums/jsoneventtype.html#value","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":41,"kind":4,"name":"ProxyType","url":"enums/proxytype.html","classes":"tsd-kind-enum"},{"id":42,"kind":16,"name":"HTTP","url":"enums/proxytype.html#http","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ProxyType"},{"id":43,"kind":16,"name":"SOCKS4","url":"enums/proxytype.html#socks4","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ProxyType"},{"id":44,"kind":16,"name":"SOCKS5","url":"enums/proxytype.html#socks5","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ProxyType"},{"id":45,"kind":4,"name":"ReplyFailure","url":"enums/replyfailure.html","classes":"tsd-kind-enum"},{"id":46,"kind":16,"name":"TIMEOUT","url":"enums/replyfailure.html#timeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ReplyFailure"},{"id":47,"kind":16,"name":"NO_HANDLERS","url":"enums/replyfailure.html#no_handlers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ReplyFailure"},{"id":48,"kind":16,"name":"RECIPIENT_FAILURE","url":"enums/replyfailure.html#recipient_failure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ReplyFailure"},{"id":49,"kind":4,"name":"WebsocketVersion","url":"enums/websocketversion.html","classes":"tsd-kind-enum"},{"id":50,"kind":16,"name":"V00","url":"enums/websocketversion.html#v00","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":51,"kind":16,"name":"V07","url":"enums/websocketversion.html#v07","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":52,"kind":16,"name":"V08","url":"enums/websocketversion.html#v08","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":53,"kind":16,"name":"V13","url":"enums/websocketversion.html#v13","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":54,"kind":128,"name":"AddressResolverOptions","url":"classes/addressresolveroptions.html","classes":"tsd-kind-class"},{"id":55,"kind":1024,"name":"cacheMaxTimeToLive","url":"classes/addressresolveroptions.html#cachemaxtimetolive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":56,"kind":1024,"name":"cacheMinTimeToLive","url":"classes/addressresolveroptions.html#cachemintimetolive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":57,"kind":1024,"name":"cacheNegativeTimeToLive","url":"classes/addressresolveroptions.html#cachenegativetimetolive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":58,"kind":1024,"name":"hostsPath","url":"classes/addressresolveroptions.html#hostspath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":59,"kind":1024,"name":"hostsValue","url":"classes/addressresolveroptions.html#hostsvalue","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":60,"kind":1024,"name":"maxQueries","url":"classes/addressresolveroptions.html#maxqueries","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":61,"kind":1024,"name":"ndots","url":"classes/addressresolveroptions.html#ndots","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":62,"kind":1024,"name":"optResourceEnabled","url":"classes/addressresolveroptions.html#optresourceenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":63,"kind":1024,"name":"queryTimeout","url":"classes/addressresolveroptions.html#querytimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":64,"kind":1024,"name":"rdFlag","url":"classes/addressresolveroptions.html#rdflag","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":65,"kind":1024,"name":"rotateServers","url":"classes/addressresolveroptions.html#rotateservers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":66,"kind":1024,"name":"searchDomains","url":"classes/addressresolveroptions.html#searchdomains","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":67,"kind":1024,"name":"servers","url":"classes/addressresolveroptions.html#servers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":68,"kind":128,"name":"Argument","url":"classes/argument.html","classes":"tsd-kind-class"},{"id":69,"kind":1024,"name":"argName","url":"classes/argument.html#argname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":70,"kind":1024,"name":"defaultValue","url":"classes/argument.html#defaultvalue","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":71,"kind":1024,"name":"description","url":"classes/argument.html#description","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":72,"kind":1024,"name":"hidden","url":"classes/argument.html#hidden","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":73,"kind":1024,"name":"index","url":"classes/argument.html#index","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":74,"kind":1024,"name":"multiValued","url":"classes/argument.html#multivalued","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":75,"kind":1024,"name":"required","url":"classes/argument.html#required","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Argument"},{"id":76,"kind":256,"name":"ClientOptionsBase","url":"interfaces/clientoptionsbase.html","classes":"tsd-kind-interface"},{"id":77,"kind":1024,"name":"connectTimeout","url":"interfaces/clientoptionsbase.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":78,"kind":1024,"name":"crlPaths","url":"interfaces/clientoptionsbase.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":79,"kind":1024,"name":"crlValues","url":"interfaces/clientoptionsbase.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":80,"kind":1024,"name":"enabledCipherSuites","url":"interfaces/clientoptionsbase.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":81,"kind":1024,"name":"enabledSecureTransportProtocols","url":"interfaces/clientoptionsbase.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":82,"kind":1024,"name":"idleTimeout","url":"interfaces/clientoptionsbase.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":83,"kind":1024,"name":"jdkSslEngineOptions","url":"interfaces/clientoptionsbase.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":84,"kind":1024,"name":"keyStoreOptions","url":"interfaces/clientoptionsbase.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":85,"kind":1024,"name":"localAddress","url":"interfaces/clientoptionsbase.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":86,"kind":1024,"name":"logActivity","url":"interfaces/clientoptionsbase.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":87,"kind":1024,"name":"metricsName","url":"interfaces/clientoptionsbase.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":88,"kind":1024,"name":"openSslEngineOptions","url":"interfaces/clientoptionsbase.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":89,"kind":1024,"name":"pemKeyCertOptions","url":"interfaces/clientoptionsbase.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":90,"kind":1024,"name":"pemTrustOptions","url":"interfaces/clientoptionsbase.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":91,"kind":1024,"name":"pfxKeyCertOptions","url":"interfaces/clientoptionsbase.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":92,"kind":1024,"name":"pfxTrustOptions","url":"interfaces/clientoptionsbase.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":93,"kind":1024,"name":"proxyOptions","url":"interfaces/clientoptionsbase.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":94,"kind":1024,"name":"receiveBufferSize","url":"interfaces/clientoptionsbase.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":95,"kind":1024,"name":"reuseAddress","url":"interfaces/clientoptionsbase.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":96,"kind":1024,"name":"reusePort","url":"interfaces/clientoptionsbase.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":97,"kind":1024,"name":"sendBufferSize","url":"interfaces/clientoptionsbase.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":98,"kind":1024,"name":"soLinger","url":"interfaces/clientoptionsbase.html#solinger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":99,"kind":1024,"name":"ssl","url":"interfaces/clientoptionsbase.html#ssl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":100,"kind":1024,"name":"tcpCork","url":"interfaces/clientoptionsbase.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":101,"kind":1024,"name":"tcpFastOpen","url":"interfaces/clientoptionsbase.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":102,"kind":1024,"name":"tcpKeepAlive","url":"interfaces/clientoptionsbase.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":103,"kind":1024,"name":"tcpNoDelay","url":"interfaces/clientoptionsbase.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":104,"kind":1024,"name":"tcpQuickAck","url":"interfaces/clientoptionsbase.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":105,"kind":1024,"name":"trafficClass","url":"interfaces/clientoptionsbase.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":106,"kind":1024,"name":"trustAll","url":"interfaces/clientoptionsbase.html#trustall","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":107,"kind":1024,"name":"trustStoreOptions","url":"interfaces/clientoptionsbase.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":108,"kind":1024,"name":"useAlpn","url":"interfaces/clientoptionsbase.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":109,"kind":1024,"name":"usePooledBuffers","url":"interfaces/clientoptionsbase.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClientOptionsBase"},{"id":110,"kind":128,"name":"CopyOptions","url":"classes/copyoptions.html","classes":"tsd-kind-class"},{"id":111,"kind":1024,"name":"atomicMove","url":"classes/copyoptions.html#atomicmove","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CopyOptions"},{"id":112,"kind":1024,"name":"copyAttributes","url":"classes/copyoptions.html#copyattributes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CopyOptions"},{"id":113,"kind":1024,"name":"nofollowLinks","url":"classes/copyoptions.html#nofollowlinks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CopyOptions"},{"id":114,"kind":1024,"name":"replaceExisting","url":"classes/copyoptions.html#replaceexisting","classes":"tsd-kind-property tsd-parent-kind-class","parent":"CopyOptions"},{"id":115,"kind":128,"name":"DatagramSocketOptions","url":"classes/datagramsocketoptions.html","classes":"tsd-kind-class"},{"id":116,"kind":1024,"name":"broadcast","url":"classes/datagramsocketoptions.html#broadcast","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":117,"kind":1024,"name":"ipV6","url":"classes/datagramsocketoptions.html#ipv6","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":118,"kind":1024,"name":"logActivity","url":"classes/datagramsocketoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":119,"kind":1024,"name":"loopbackModeDisabled","url":"classes/datagramsocketoptions.html#loopbackmodedisabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":120,"kind":1024,"name":"multicastNetworkInterface","url":"classes/datagramsocketoptions.html#multicastnetworkinterface","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":121,"kind":1024,"name":"multicastTimeToLive","url":"classes/datagramsocketoptions.html#multicasttimetolive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":122,"kind":1024,"name":"receiveBufferSize","url":"classes/datagramsocketoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":123,"kind":1024,"name":"reuseAddress","url":"classes/datagramsocketoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":124,"kind":1024,"name":"reusePort","url":"classes/datagramsocketoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":125,"kind":1024,"name":"sendBufferSize","url":"classes/datagramsocketoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":126,"kind":1024,"name":"trafficClass","url":"classes/datagramsocketoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":127,"kind":128,"name":"DeliveryOptions","url":"classes/deliveryoptions.html","classes":"tsd-kind-class"},{"id":128,"kind":1024,"name":"codecName","url":"classes/deliveryoptions.html#codecname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":129,"kind":1024,"name":"headers","url":"classes/deliveryoptions.html#headers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":130,"kind":1024,"name":"sendTimeout","url":"classes/deliveryoptions.html#sendtimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":131,"kind":128,"name":"DeploymentOptions","url":"classes/deploymentoptions.html","classes":"tsd-kind-class"},{"id":132,"kind":1024,"name":"config","url":"classes/deploymentoptions.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":133,"kind":1024,"name":"extraClasspath","url":"classes/deploymentoptions.html#extraclasspath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":134,"kind":1024,"name":"ha","url":"classes/deploymentoptions.html#ha","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":135,"kind":1024,"name":"instances","url":"classes/deploymentoptions.html#instances","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":136,"kind":1024,"name":"isolatedClasses","url":"classes/deploymentoptions.html#isolatedclasses","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":137,"kind":1024,"name":"isolationGroup","url":"classes/deploymentoptions.html#isolationgroup","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":138,"kind":1024,"name":"maxWorkerExecuteTime","url":"classes/deploymentoptions.html#maxworkerexecutetime","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":139,"kind":1024,"name":"multiThreaded","url":"classes/deploymentoptions.html#multithreaded","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":140,"kind":1024,"name":"worker","url":"classes/deploymentoptions.html#worker","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":141,"kind":1024,"name":"workerPoolName","url":"classes/deploymentoptions.html#workerpoolname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":142,"kind":1024,"name":"workerPoolSize","url":"classes/deploymentoptions.html#workerpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":143,"kind":128,"name":"DnsClientOptions","url":"classes/dnsclientoptions.html","classes":"tsd-kind-class"},{"id":144,"kind":1024,"name":"host","url":"classes/dnsclientoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":145,"kind":1024,"name":"port","url":"classes/dnsclientoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":146,"kind":1024,"name":"queryTimeout","url":"classes/dnsclientoptions.html#querytimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":147,"kind":128,"name":"EventBusOptions","url":"classes/eventbusoptions.html","classes":"tsd-kind-class"},{"id":148,"kind":1024,"name":"acceptBacklog","url":"classes/eventbusoptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":149,"kind":1024,"name":"clientAuth","url":"classes/eventbusoptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":150,"kind":1024,"name":"clusterPingInterval","url":"classes/eventbusoptions.html#clusterpinginterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":151,"kind":1024,"name":"clusterPingReplyInterval","url":"classes/eventbusoptions.html#clusterpingreplyinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":152,"kind":1024,"name":"clusterPublicHost","url":"classes/eventbusoptions.html#clusterpublichost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":153,"kind":1024,"name":"clusterPublicPort","url":"classes/eventbusoptions.html#clusterpublicport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":154,"kind":1024,"name":"clustered","url":"classes/eventbusoptions.html#clustered","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":155,"kind":1024,"name":"connectTimeout","url":"classes/eventbusoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":156,"kind":1024,"name":"crlPaths","url":"classes/eventbusoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":157,"kind":1024,"name":"crlValues","url":"classes/eventbusoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":158,"kind":1024,"name":"enabledCipherSuites","url":"classes/eventbusoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":159,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/eventbusoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":160,"kind":1024,"name":"host","url":"classes/eventbusoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":161,"kind":1024,"name":"idleTimeout","url":"classes/eventbusoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":162,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/eventbusoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":163,"kind":1024,"name":"keyStoreOptions","url":"classes/eventbusoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":164,"kind":1024,"name":"logActivity","url":"classes/eventbusoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":165,"kind":1024,"name":"openSslEngineOptions","url":"classes/eventbusoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":166,"kind":1024,"name":"pemKeyCertOptions","url":"classes/eventbusoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":167,"kind":1024,"name":"pemTrustOptions","url":"classes/eventbusoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":168,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/eventbusoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":169,"kind":1024,"name":"pfxTrustOptions","url":"classes/eventbusoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":170,"kind":1024,"name":"port","url":"classes/eventbusoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":171,"kind":1024,"name":"receiveBufferSize","url":"classes/eventbusoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":172,"kind":1024,"name":"reconnectAttempts","url":"classes/eventbusoptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":173,"kind":1024,"name":"reconnectInterval","url":"classes/eventbusoptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":174,"kind":1024,"name":"reuseAddress","url":"classes/eventbusoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":175,"kind":1024,"name":"reusePort","url":"classes/eventbusoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":176,"kind":1024,"name":"sendBufferSize","url":"classes/eventbusoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":177,"kind":1024,"name":"soLinger","url":"classes/eventbusoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":178,"kind":1024,"name":"ssl","url":"classes/eventbusoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":179,"kind":1024,"name":"tcpCork","url":"classes/eventbusoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":180,"kind":1024,"name":"tcpFastOpen","url":"classes/eventbusoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":181,"kind":1024,"name":"tcpKeepAlive","url":"classes/eventbusoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":182,"kind":1024,"name":"tcpNoDelay","url":"classes/eventbusoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":183,"kind":1024,"name":"tcpQuickAck","url":"classes/eventbusoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":184,"kind":1024,"name":"trafficClass","url":"classes/eventbusoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":185,"kind":1024,"name":"trustAll","url":"classes/eventbusoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":186,"kind":1024,"name":"trustStoreOptions","url":"classes/eventbusoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":187,"kind":1024,"name":"useAlpn","url":"classes/eventbusoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":188,"kind":1024,"name":"usePooledBuffers","url":"classes/eventbusoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"EventBusOptions"},{"id":189,"kind":128,"name":"GoAway","url":"classes/goaway.html","classes":"tsd-kind-class"},{"id":190,"kind":1024,"name":"debugData","url":"classes/goaway.html#debugdata","classes":"tsd-kind-property tsd-parent-kind-class","parent":"GoAway"},{"id":191,"kind":1024,"name":"errorCode","url":"classes/goaway.html#errorcode","classes":"tsd-kind-property tsd-parent-kind-class","parent":"GoAway"},{"id":192,"kind":1024,"name":"lastStreamId","url":"classes/goaway.html#laststreamid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"GoAway"},{"id":193,"kind":128,"name":"Http2Settings","url":"classes/http2settings.html","classes":"tsd-kind-class"},{"id":194,"kind":1024,"name":"headerTableSize","url":"classes/http2settings.html#headertablesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Http2Settings"},{"id":195,"kind":1024,"name":"initialWindowSize","url":"classes/http2settings.html#initialwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Http2Settings"},{"id":196,"kind":1024,"name":"maxConcurrentStreams","url":"classes/http2settings.html#maxconcurrentstreams","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Http2Settings"},{"id":197,"kind":1024,"name":"maxFrameSize","url":"classes/http2settings.html#maxframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Http2Settings"},{"id":198,"kind":1024,"name":"maxHeaderListSize","url":"classes/http2settings.html#maxheaderlistsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Http2Settings"},{"id":199,"kind":1024,"name":"pushEnabled","url":"classes/http2settings.html#pushenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Http2Settings"},{"id":200,"kind":128,"name":"HttpClientOptions","url":"classes/httpclientoptions.html","classes":"tsd-kind-class"},{"id":201,"kind":1024,"name":"alpnVersions","url":"classes/httpclientoptions.html#alpnversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":202,"kind":1024,"name":"connectTimeout","url":"classes/httpclientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":203,"kind":1024,"name":"crlPaths","url":"classes/httpclientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":204,"kind":1024,"name":"crlValues","url":"classes/httpclientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":205,"kind":1024,"name":"decoderInitialBufferSize","url":"classes/httpclientoptions.html#decoderinitialbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":206,"kind":1024,"name":"defaultHost","url":"classes/httpclientoptions.html#defaulthost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":207,"kind":1024,"name":"defaultPort","url":"classes/httpclientoptions.html#defaultport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":208,"kind":1024,"name":"enabledCipherSuites","url":"classes/httpclientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":209,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/httpclientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":210,"kind":1024,"name":"forceSni","url":"classes/httpclientoptions.html#forcesni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":211,"kind":1024,"name":"http2ClearTextUpgrade","url":"classes/httpclientoptions.html#http2cleartextupgrade","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":212,"kind":1024,"name":"http2ConnectionWindowSize","url":"classes/httpclientoptions.html#http2connectionwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":213,"kind":1024,"name":"http2KeepAliveTimeout","url":"classes/httpclientoptions.html#http2keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":214,"kind":1024,"name":"http2MaxPoolSize","url":"classes/httpclientoptions.html#http2maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":215,"kind":1024,"name":"http2MultiplexingLimit","url":"classes/httpclientoptions.html#http2multiplexinglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":216,"kind":1024,"name":"idleTimeout","url":"classes/httpclientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":217,"kind":1024,"name":"initialSettings","url":"classes/httpclientoptions.html#initialsettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":218,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/httpclientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":219,"kind":1024,"name":"keepAlive","url":"classes/httpclientoptions.html#keepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":220,"kind":1024,"name":"keepAliveTimeout","url":"classes/httpclientoptions.html#keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":221,"kind":1024,"name":"keyStoreOptions","url":"classes/httpclientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":222,"kind":1024,"name":"localAddress","url":"classes/httpclientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":223,"kind":1024,"name":"logActivity","url":"classes/httpclientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":224,"kind":1024,"name":"maxChunkSize","url":"classes/httpclientoptions.html#maxchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":225,"kind":1024,"name":"maxHeaderSize","url":"classes/httpclientoptions.html#maxheadersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":226,"kind":1024,"name":"maxInitialLineLength","url":"classes/httpclientoptions.html#maxinitiallinelength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":227,"kind":1024,"name":"maxPoolSize","url":"classes/httpclientoptions.html#maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":228,"kind":1024,"name":"maxRedirects","url":"classes/httpclientoptions.html#maxredirects","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":229,"kind":1024,"name":"maxWaitQueueSize","url":"classes/httpclientoptions.html#maxwaitqueuesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":230,"kind":1024,"name":"maxWebsocketFrameSize","url":"classes/httpclientoptions.html#maxwebsocketframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":231,"kind":1024,"name":"maxWebsocketMessageSize","url":"classes/httpclientoptions.html#maxwebsocketmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":232,"kind":1024,"name":"metricsName","url":"classes/httpclientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":233,"kind":1024,"name":"openSslEngineOptions","url":"classes/httpclientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":234,"kind":1024,"name":"pemKeyCertOptions","url":"classes/httpclientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":235,"kind":1024,"name":"pemTrustOptions","url":"classes/httpclientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":236,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/httpclientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":237,"kind":1024,"name":"pfxTrustOptions","url":"classes/httpclientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":238,"kind":1024,"name":"pipelining","url":"classes/httpclientoptions.html#pipelining","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":239,"kind":1024,"name":"pipeliningLimit","url":"classes/httpclientoptions.html#pipelininglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":240,"kind":1024,"name":"poolCleanerPeriod","url":"classes/httpclientoptions.html#poolcleanerperiod","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":241,"kind":1024,"name":"protocolVersion","url":"classes/httpclientoptions.html#protocolversion","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":242,"kind":1024,"name":"proxyOptions","url":"classes/httpclientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":243,"kind":1024,"name":"receiveBufferSize","url":"classes/httpclientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":244,"kind":1024,"name":"reuseAddress","url":"classes/httpclientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":245,"kind":1024,"name":"reusePort","url":"classes/httpclientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":246,"kind":1024,"name":"sendBufferSize","url":"classes/httpclientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":247,"kind":1024,"name":"sendUnmaskedFrames","url":"classes/httpclientoptions.html#sendunmaskedframes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":248,"kind":1024,"name":"soLinger","url":"classes/httpclientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":249,"kind":1024,"name":"ssl","url":"classes/httpclientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":250,"kind":1024,"name":"tcpCork","url":"classes/httpclientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":251,"kind":1024,"name":"tcpFastOpen","url":"classes/httpclientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":252,"kind":1024,"name":"tcpKeepAlive","url":"classes/httpclientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":253,"kind":1024,"name":"tcpNoDelay","url":"classes/httpclientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":254,"kind":1024,"name":"tcpQuickAck","url":"classes/httpclientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":255,"kind":1024,"name":"trafficClass","url":"classes/httpclientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":256,"kind":1024,"name":"trustAll","url":"classes/httpclientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":257,"kind":1024,"name":"trustStoreOptions","url":"classes/httpclientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":258,"kind":1024,"name":"tryUseCompression","url":"classes/httpclientoptions.html#tryusecompression","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":259,"kind":1024,"name":"useAlpn","url":"classes/httpclientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":260,"kind":1024,"name":"usePooledBuffers","url":"classes/httpclientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":261,"kind":1024,"name":"verifyHost","url":"classes/httpclientoptions.html#verifyhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":262,"kind":128,"name":"HttpServerOptions","url":"classes/httpserveroptions.html","classes":"tsd-kind-class"},{"id":263,"kind":1024,"name":"acceptBacklog","url":"classes/httpserveroptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":264,"kind":1024,"name":"acceptUnmaskedFrames","url":"classes/httpserveroptions.html#acceptunmaskedframes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":265,"kind":1024,"name":"alpnVersions","url":"classes/httpserveroptions.html#alpnversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":266,"kind":1024,"name":"clientAuth","url":"classes/httpserveroptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":267,"kind":1024,"name":"clientAuthRequired","url":"classes/httpserveroptions.html#clientauthrequired","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":268,"kind":1024,"name":"compressionLevel","url":"classes/httpserveroptions.html#compressionlevel","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":269,"kind":1024,"name":"compressionSupported","url":"classes/httpserveroptions.html#compressionsupported","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":270,"kind":1024,"name":"crlPaths","url":"classes/httpserveroptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":271,"kind":1024,"name":"crlValues","url":"classes/httpserveroptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":272,"kind":1024,"name":"decoderInitialBufferSize","url":"classes/httpserveroptions.html#decoderinitialbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":273,"kind":1024,"name":"decompressionSupported","url":"classes/httpserveroptions.html#decompressionsupported","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":274,"kind":1024,"name":"enabledCipherSuites","url":"classes/httpserveroptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":275,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/httpserveroptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":276,"kind":1024,"name":"handle100ContinueAutomatically","url":"classes/httpserveroptions.html#handle100continueautomatically","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":277,"kind":1024,"name":"host","url":"classes/httpserveroptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":278,"kind":1024,"name":"http2ConnectionWindowSize","url":"classes/httpserveroptions.html#http2connectionwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":279,"kind":1024,"name":"idleTimeout","url":"classes/httpserveroptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":280,"kind":1024,"name":"initialSettings","url":"classes/httpserveroptions.html#initialsettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":281,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/httpserveroptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":282,"kind":1024,"name":"keyStoreOptions","url":"classes/httpserveroptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":283,"kind":1024,"name":"logActivity","url":"classes/httpserveroptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":284,"kind":1024,"name":"maxChunkSize","url":"classes/httpserveroptions.html#maxchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":285,"kind":1024,"name":"maxHeaderSize","url":"classes/httpserveroptions.html#maxheadersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":286,"kind":1024,"name":"maxInitialLineLength","url":"classes/httpserveroptions.html#maxinitiallinelength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":287,"kind":1024,"name":"maxWebsocketFrameSize","url":"classes/httpserveroptions.html#maxwebsocketframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":288,"kind":1024,"name":"maxWebsocketMessageSize","url":"classes/httpserveroptions.html#maxwebsocketmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":289,"kind":1024,"name":"openSslEngineOptions","url":"classes/httpserveroptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":290,"kind":1024,"name":"pemKeyCertOptions","url":"classes/httpserveroptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":291,"kind":1024,"name":"pemTrustOptions","url":"classes/httpserveroptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":292,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/httpserveroptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":293,"kind":1024,"name":"pfxTrustOptions","url":"classes/httpserveroptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":294,"kind":1024,"name":"port","url":"classes/httpserveroptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":295,"kind":1024,"name":"receiveBufferSize","url":"classes/httpserveroptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":296,"kind":1024,"name":"reuseAddress","url":"classes/httpserveroptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":297,"kind":1024,"name":"reusePort","url":"classes/httpserveroptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":298,"kind":1024,"name":"sendBufferSize","url":"classes/httpserveroptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":299,"kind":1024,"name":"sni","url":"classes/httpserveroptions.html#sni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":300,"kind":1024,"name":"soLinger","url":"classes/httpserveroptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":301,"kind":1024,"name":"ssl","url":"classes/httpserveroptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":302,"kind":1024,"name":"tcpCork","url":"classes/httpserveroptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":303,"kind":1024,"name":"tcpFastOpen","url":"classes/httpserveroptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":304,"kind":1024,"name":"tcpKeepAlive","url":"classes/httpserveroptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":305,"kind":1024,"name":"tcpNoDelay","url":"classes/httpserveroptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":306,"kind":1024,"name":"tcpQuickAck","url":"classes/httpserveroptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":307,"kind":1024,"name":"trafficClass","url":"classes/httpserveroptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":308,"kind":1024,"name":"trustStoreOptions","url":"classes/httpserveroptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":309,"kind":1024,"name":"useAlpn","url":"classes/httpserveroptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":310,"kind":1024,"name":"usePooledBuffers","url":"classes/httpserveroptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":311,"kind":1024,"name":"websocketSubProtocols","url":"classes/httpserveroptions.html#websocketsubprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":312,"kind":128,"name":"JdkSSLEngineOptions","url":"classes/jdksslengineoptions.html","classes":"tsd-kind-class"},{"id":313,"kind":128,"name":"JksOptions","url":"classes/jksoptions.html","classes":"tsd-kind-class"},{"id":314,"kind":1024,"name":"password","url":"classes/jksoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JksOptions"},{"id":315,"kind":1024,"name":"path","url":"classes/jksoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JksOptions"},{"id":316,"kind":1024,"name":"value","url":"classes/jksoptions.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"JksOptions"},{"id":317,"kind":128,"name":"MetricsOptions","url":"classes/metricsoptions.html","classes":"tsd-kind-class"},{"id":318,"kind":1024,"name":"enabled","url":"classes/metricsoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MetricsOptions"},{"id":319,"kind":128,"name":"NetClientOptions","url":"classes/netclientoptions.html","classes":"tsd-kind-class"},{"id":320,"kind":1024,"name":"connectTimeout","url":"classes/netclientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":321,"kind":1024,"name":"crlPaths","url":"classes/netclientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":322,"kind":1024,"name":"crlValues","url":"classes/netclientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":323,"kind":1024,"name":"enabledCipherSuites","url":"classes/netclientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":324,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/netclientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":325,"kind":1024,"name":"hostnameVerificationAlgorithm","url":"classes/netclientoptions.html#hostnameverificationalgorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":326,"kind":1024,"name":"idleTimeout","url":"classes/netclientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":327,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/netclientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":328,"kind":1024,"name":"keyStoreOptions","url":"classes/netclientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":329,"kind":1024,"name":"localAddress","url":"classes/netclientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":330,"kind":1024,"name":"logActivity","url":"classes/netclientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":331,"kind":1024,"name":"metricsName","url":"classes/netclientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":332,"kind":1024,"name":"openSslEngineOptions","url":"classes/netclientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":333,"kind":1024,"name":"pemKeyCertOptions","url":"classes/netclientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":334,"kind":1024,"name":"pemTrustOptions","url":"classes/netclientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":335,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/netclientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":336,"kind":1024,"name":"pfxTrustOptions","url":"classes/netclientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":337,"kind":1024,"name":"proxyOptions","url":"classes/netclientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":338,"kind":1024,"name":"receiveBufferSize","url":"classes/netclientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":339,"kind":1024,"name":"reconnectAttempts","url":"classes/netclientoptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":340,"kind":1024,"name":"reconnectInterval","url":"classes/netclientoptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":341,"kind":1024,"name":"reuseAddress","url":"classes/netclientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":342,"kind":1024,"name":"reusePort","url":"classes/netclientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":343,"kind":1024,"name":"sendBufferSize","url":"classes/netclientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":344,"kind":1024,"name":"soLinger","url":"classes/netclientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":345,"kind":1024,"name":"ssl","url":"classes/netclientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":346,"kind":1024,"name":"tcpCork","url":"classes/netclientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":347,"kind":1024,"name":"tcpFastOpen","url":"classes/netclientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":348,"kind":1024,"name":"tcpKeepAlive","url":"classes/netclientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":349,"kind":1024,"name":"tcpNoDelay","url":"classes/netclientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":350,"kind":1024,"name":"tcpQuickAck","url":"classes/netclientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":351,"kind":1024,"name":"trafficClass","url":"classes/netclientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":352,"kind":1024,"name":"trustAll","url":"classes/netclientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":353,"kind":1024,"name":"trustStoreOptions","url":"classes/netclientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":354,"kind":1024,"name":"useAlpn","url":"classes/netclientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":355,"kind":1024,"name":"usePooledBuffers","url":"classes/netclientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetClientOptions"},{"id":356,"kind":128,"name":"NetServerOptions","url":"classes/netserveroptions.html","classes":"tsd-kind-class"},{"id":357,"kind":1024,"name":"acceptBacklog","url":"classes/netserveroptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":358,"kind":1024,"name":"clientAuth","url":"classes/netserveroptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":359,"kind":1024,"name":"clientAuthRequired","url":"classes/netserveroptions.html#clientauthrequired","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":360,"kind":1024,"name":"crlPaths","url":"classes/netserveroptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":361,"kind":1024,"name":"crlValues","url":"classes/netserveroptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":362,"kind":1024,"name":"enabledCipherSuites","url":"classes/netserveroptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":363,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/netserveroptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":364,"kind":1024,"name":"host","url":"classes/netserveroptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":365,"kind":1024,"name":"idleTimeout","url":"classes/netserveroptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":366,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/netserveroptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":367,"kind":1024,"name":"keyStoreOptions","url":"classes/netserveroptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":368,"kind":1024,"name":"logActivity","url":"classes/netserveroptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":369,"kind":1024,"name":"openSslEngineOptions","url":"classes/netserveroptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":370,"kind":1024,"name":"pemKeyCertOptions","url":"classes/netserveroptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":371,"kind":1024,"name":"pemTrustOptions","url":"classes/netserveroptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":372,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/netserveroptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":373,"kind":1024,"name":"pfxTrustOptions","url":"classes/netserveroptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":374,"kind":1024,"name":"port","url":"classes/netserveroptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":375,"kind":1024,"name":"receiveBufferSize","url":"classes/netserveroptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":376,"kind":1024,"name":"reuseAddress","url":"classes/netserveroptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":377,"kind":1024,"name":"reusePort","url":"classes/netserveroptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":378,"kind":1024,"name":"sendBufferSize","url":"classes/netserveroptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":379,"kind":1024,"name":"sni","url":"classes/netserveroptions.html#sni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":380,"kind":1024,"name":"soLinger","url":"classes/netserveroptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":381,"kind":1024,"name":"ssl","url":"classes/netserveroptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":382,"kind":1024,"name":"tcpCork","url":"classes/netserveroptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":383,"kind":1024,"name":"tcpFastOpen","url":"classes/netserveroptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":384,"kind":1024,"name":"tcpKeepAlive","url":"classes/netserveroptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":385,"kind":1024,"name":"tcpNoDelay","url":"classes/netserveroptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":386,"kind":1024,"name":"tcpQuickAck","url":"classes/netserveroptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":387,"kind":1024,"name":"trafficClass","url":"classes/netserveroptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":388,"kind":1024,"name":"trustStoreOptions","url":"classes/netserveroptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":389,"kind":1024,"name":"useAlpn","url":"classes/netserveroptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":390,"kind":1024,"name":"usePooledBuffers","url":"classes/netserveroptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"NetServerOptions"},{"id":391,"kind":256,"name":"NetworkOptions","url":"interfaces/networkoptions.html","classes":"tsd-kind-interface"},{"id":392,"kind":1024,"name":"logActivity","url":"interfaces/networkoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NetworkOptions"},{"id":393,"kind":1024,"name":"receiveBufferSize","url":"interfaces/networkoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NetworkOptions"},{"id":394,"kind":1024,"name":"reuseAddress","url":"interfaces/networkoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NetworkOptions"},{"id":395,"kind":1024,"name":"reusePort","url":"interfaces/networkoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NetworkOptions"},{"id":396,"kind":1024,"name":"sendBufferSize","url":"interfaces/networkoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NetworkOptions"},{"id":397,"kind":1024,"name":"trafficClass","url":"interfaces/networkoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NetworkOptions"},{"id":398,"kind":128,"name":"OpenOptions","url":"classes/openoptions.html","classes":"tsd-kind-class"},{"id":399,"kind":1024,"name":"append","url":"classes/openoptions.html#append","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":400,"kind":1024,"name":"create","url":"classes/openoptions.html#create","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":401,"kind":1024,"name":"createNew","url":"classes/openoptions.html#createnew","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":402,"kind":1024,"name":"deleteOnClose","url":"classes/openoptions.html#deleteonclose","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":403,"kind":1024,"name":"dsync","url":"classes/openoptions.html#dsync","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":404,"kind":1024,"name":"perms","url":"classes/openoptions.html#perms","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":405,"kind":1024,"name":"read","url":"classes/openoptions.html#read","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":406,"kind":1024,"name":"sparse","url":"classes/openoptions.html#sparse","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":407,"kind":1024,"name":"sync","url":"classes/openoptions.html#sync","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":408,"kind":1024,"name":"truncateExisting","url":"classes/openoptions.html#truncateexisting","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":409,"kind":1024,"name":"write","url":"classes/openoptions.html#write","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenOptions"},{"id":410,"kind":128,"name":"OpenSSLEngineOptions","url":"classes/opensslengineoptions.html","classes":"tsd-kind-class"},{"id":411,"kind":1024,"name":"sessionCacheEnabled","url":"classes/opensslengineoptions.html#sessioncacheenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenSSLEngineOptions"},{"id":412,"kind":128,"name":"Option","url":"classes/option.html","classes":"tsd-kind-class"},{"id":413,"kind":1024,"name":"argName","url":"classes/option.html#argname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":414,"kind":1024,"name":"choices","url":"classes/option.html#choices","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":415,"kind":1024,"name":"defaultValue","url":"classes/option.html#defaultvalue","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":416,"kind":1024,"name":"description","url":"classes/option.html#description","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":417,"kind":1024,"name":"flag","url":"classes/option.html#flag","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":418,"kind":1024,"name":"help","url":"classes/option.html#help","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":419,"kind":1024,"name":"hidden","url":"classes/option.html#hidden","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":420,"kind":1024,"name":"longName","url":"classes/option.html#longname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":421,"kind":1024,"name":"multiValued","url":"classes/option.html#multivalued","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":422,"kind":1024,"name":"required","url":"classes/option.html#required","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":423,"kind":1024,"name":"shortName","url":"classes/option.html#shortname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":424,"kind":1024,"name":"singleValued","url":"classes/option.html#singlevalued","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Option"},{"id":425,"kind":128,"name":"PemKeyCertOptions","url":"classes/pemkeycertoptions.html","classes":"tsd-kind-class"},{"id":426,"kind":1024,"name":"certPath","url":"classes/pemkeycertoptions.html#certpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":427,"kind":1024,"name":"certPaths","url":"classes/pemkeycertoptions.html#certpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":428,"kind":1024,"name":"certValue","url":"classes/pemkeycertoptions.html#certvalue","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":429,"kind":1024,"name":"certValues","url":"classes/pemkeycertoptions.html#certvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":430,"kind":1024,"name":"keyPath","url":"classes/pemkeycertoptions.html#keypath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":431,"kind":1024,"name":"keyPaths","url":"classes/pemkeycertoptions.html#keypaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":432,"kind":1024,"name":"keyValue","url":"classes/pemkeycertoptions.html#keyvalue","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":433,"kind":1024,"name":"keyValues","url":"classes/pemkeycertoptions.html#keyvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":434,"kind":128,"name":"PemTrustOptions","url":"classes/pemtrustoptions.html","classes":"tsd-kind-class"},{"id":435,"kind":1024,"name":"certPaths","url":"classes/pemtrustoptions.html#certpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":436,"kind":1024,"name":"certValues","url":"classes/pemtrustoptions.html#certvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":437,"kind":128,"name":"PfxOptions","url":"classes/pfxoptions.html","classes":"tsd-kind-class"},{"id":438,"kind":1024,"name":"password","url":"classes/pfxoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PfxOptions"},{"id":439,"kind":1024,"name":"path","url":"classes/pfxoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PfxOptions"},{"id":440,"kind":1024,"name":"value","url":"classes/pfxoptions.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PfxOptions"},{"id":441,"kind":128,"name":"ProxyOptions","url":"classes/proxyoptions.html","classes":"tsd-kind-class"},{"id":442,"kind":1024,"name":"host","url":"classes/proxyoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProxyOptions"},{"id":443,"kind":1024,"name":"password","url":"classes/proxyoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProxyOptions"},{"id":444,"kind":1024,"name":"port","url":"classes/proxyoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProxyOptions"},{"id":445,"kind":1024,"name":"type","url":"classes/proxyoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProxyOptions"},{"id":446,"kind":1024,"name":"username","url":"classes/proxyoptions.html#username","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProxyOptions"},{"id":447,"kind":128,"name":"RequestOptions","url":"classes/requestoptions.html","classes":"tsd-kind-class"},{"id":448,"kind":1024,"name":"host","url":"classes/requestoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RequestOptions"},{"id":449,"kind":1024,"name":"port","url":"classes/requestoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RequestOptions"},{"id":450,"kind":1024,"name":"ssl","url":"classes/requestoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RequestOptions"},{"id":451,"kind":1024,"name":"uri","url":"classes/requestoptions.html#uri","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RequestOptions"},{"id":452,"kind":256,"name":"TCPSSLOptions","url":"interfaces/tcpssloptions.html","classes":"tsd-kind-interface"},{"id":453,"kind":1024,"name":"crlPaths","url":"interfaces/tcpssloptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":454,"kind":1024,"name":"crlValues","url":"interfaces/tcpssloptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":455,"kind":1024,"name":"enabledCipherSuites","url":"interfaces/tcpssloptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":456,"kind":1024,"name":"enabledSecureTransportProtocols","url":"interfaces/tcpssloptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":457,"kind":1024,"name":"idleTimeout","url":"interfaces/tcpssloptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":458,"kind":1024,"name":"jdkSslEngineOptions","url":"interfaces/tcpssloptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":459,"kind":1024,"name":"keyStoreOptions","url":"interfaces/tcpssloptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":460,"kind":1024,"name":"logActivity","url":"interfaces/tcpssloptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":461,"kind":1024,"name":"openSslEngineOptions","url":"interfaces/tcpssloptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":462,"kind":1024,"name":"pemKeyCertOptions","url":"interfaces/tcpssloptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":463,"kind":1024,"name":"pemTrustOptions","url":"interfaces/tcpssloptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":464,"kind":1024,"name":"pfxKeyCertOptions","url":"interfaces/tcpssloptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":465,"kind":1024,"name":"pfxTrustOptions","url":"interfaces/tcpssloptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":466,"kind":1024,"name":"receiveBufferSize","url":"interfaces/tcpssloptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":467,"kind":1024,"name":"reuseAddress","url":"interfaces/tcpssloptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":468,"kind":1024,"name":"reusePort","url":"interfaces/tcpssloptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":469,"kind":1024,"name":"sendBufferSize","url":"interfaces/tcpssloptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":470,"kind":1024,"name":"soLinger","url":"interfaces/tcpssloptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":471,"kind":1024,"name":"ssl","url":"interfaces/tcpssloptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":472,"kind":1024,"name":"tcpCork","url":"interfaces/tcpssloptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":473,"kind":1024,"name":"tcpFastOpen","url":"interfaces/tcpssloptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":474,"kind":1024,"name":"tcpKeepAlive","url":"interfaces/tcpssloptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":475,"kind":1024,"name":"tcpNoDelay","url":"interfaces/tcpssloptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":476,"kind":1024,"name":"tcpQuickAck","url":"interfaces/tcpssloptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":477,"kind":1024,"name":"trafficClass","url":"interfaces/tcpssloptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":478,"kind":1024,"name":"trustStoreOptions","url":"interfaces/tcpssloptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":479,"kind":1024,"name":"useAlpn","url":"interfaces/tcpssloptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":480,"kind":1024,"name":"usePooledBuffers","url":"interfaces/tcpssloptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TCPSSLOptions"},{"id":481,"kind":128,"name":"VertxOptions","url":"classes/vertxoptions.html","classes":"tsd-kind-class"},{"id":482,"kind":1024,"name":"addressResolverOptions","url":"classes/vertxoptions.html#addressresolveroptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":483,"kind":1024,"name":"blockedThreadCheckInterval","url":"classes/vertxoptions.html#blockedthreadcheckinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":484,"kind":1024,"name":"clusterHost","url":"classes/vertxoptions.html#clusterhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":485,"kind":1024,"name":"clusterPingInterval","url":"classes/vertxoptions.html#clusterpinginterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":486,"kind":1024,"name":"clusterPingReplyInterval","url":"classes/vertxoptions.html#clusterpingreplyinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":487,"kind":1024,"name":"clusterPort","url":"classes/vertxoptions.html#clusterport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":488,"kind":1024,"name":"clusterPublicHost","url":"classes/vertxoptions.html#clusterpublichost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":489,"kind":1024,"name":"clusterPublicPort","url":"classes/vertxoptions.html#clusterpublicport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":490,"kind":1024,"name":"clustered","url":"classes/vertxoptions.html#clustered","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":491,"kind":1024,"name":"eventBusOptions","url":"classes/vertxoptions.html#eventbusoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":492,"kind":1024,"name":"eventLoopPoolSize","url":"classes/vertxoptions.html#eventlooppoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":493,"kind":1024,"name":"fileResolverCachingEnabled","url":"classes/vertxoptions.html#fileresolvercachingenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":494,"kind":1024,"name":"haEnabled","url":"classes/vertxoptions.html#haenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":495,"kind":1024,"name":"haGroup","url":"classes/vertxoptions.html#hagroup","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":496,"kind":1024,"name":"internalBlockingPoolSize","url":"classes/vertxoptions.html#internalblockingpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":497,"kind":1024,"name":"maxEventLoopExecuteTime","url":"classes/vertxoptions.html#maxeventloopexecutetime","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":498,"kind":1024,"name":"maxWorkerExecuteTime","url":"classes/vertxoptions.html#maxworkerexecutetime","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":499,"kind":1024,"name":"metricsOptions","url":"classes/vertxoptions.html#metricsoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":500,"kind":1024,"name":"preferNativeTransport","url":"classes/vertxoptions.html#prefernativetransport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":501,"kind":1024,"name":"quorumSize","url":"classes/vertxoptions.html#quorumsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":502,"kind":1024,"name":"warningExceptionTime","url":"classes/vertxoptions.html#warningexceptiontime","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":503,"kind":1024,"name":"workerPoolSize","url":"classes/vertxoptions.html#workerpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxOptions"},{"id":504,"kind":256,"name":"AsyncResult","url":"interfaces/asyncresult.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":505,"kind":2048,"name":"succeeded","url":"interfaces/asyncresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":506,"kind":2048,"name":"failed","url":"interfaces/asyncresult.html#failed","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":507,"kind":2048,"name":"cause","url":"interfaces/asyncresult.html#cause","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":508,"kind":2048,"name":"result","url":"interfaces/asyncresult.html#result","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":509,"kind":128,"name":"AsyncFile","url":"classes/asyncfile.html","classes":"tsd-kind-class"},{"id":510,"kind":2048,"name":"end","url":"classes/asyncfile.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":511,"kind":2048,"name":"writeQueueFull","url":"classes/asyncfile.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":512,"kind":2048,"name":"handler","url":"classes/asyncfile.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":513,"kind":2048,"name":"pause","url":"classes/asyncfile.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":514,"kind":2048,"name":"resume","url":"classes/asyncfile.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":515,"kind":2048,"name":"endHandler","url":"classes/asyncfile.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":516,"kind":2048,"name":"write","url":"classes/asyncfile.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":517,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/asyncfile.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":518,"kind":2048,"name":"drainHandler","url":"classes/asyncfile.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":519,"kind":2048,"name":"exceptionHandler","url":"classes/asyncfile.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":520,"kind":2048,"name":"close","url":"classes/asyncfile.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":521,"kind":2048,"name":"read","url":"classes/asyncfile.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":522,"kind":2048,"name":"flush","url":"classes/asyncfile.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":523,"kind":2048,"name":"setReadPos","url":"classes/asyncfile.html#setreadpos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":524,"kind":2048,"name":"setWritePos","url":"classes/asyncfile.html#setwritepos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":525,"kind":2048,"name":"setReadBufferSize","url":"classes/asyncfile.html#setreadbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":526,"kind":128,"name":"AsyncMap","url":"classes/asyncmap.html","classes":"tsd-kind-class"},{"id":527,"kind":2048,"name":"get","url":"classes/asyncmap.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":528,"kind":2048,"name":"put","url":"classes/asyncmap.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":529,"kind":2048,"name":"putIfAbsent","url":"classes/asyncmap.html#putifabsent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":530,"kind":2048,"name":"remove","url":"classes/asyncmap.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":531,"kind":2048,"name":"removeIfPresent","url":"classes/asyncmap.html#removeifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":532,"kind":2048,"name":"replace","url":"classes/asyncmap.html#replace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":533,"kind":2048,"name":"replaceIfPresent","url":"classes/asyncmap.html#replaceifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":534,"kind":2048,"name":"clear","url":"classes/asyncmap.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":535,"kind":2048,"name":"size","url":"classes/asyncmap.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":536,"kind":128,"name":"Buffer","url":"classes/buffer.html","classes":"tsd-kind-class"},{"id":537,"kind":2048,"name":"buffer","url":"classes/buffer.html#buffer-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Buffer"},{"id":538,"kind":2048,"name":"toString","url":"classes/buffer.html#tostring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":539,"kind":2048,"name":"toJsonObject","url":"classes/buffer.html#tojsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":540,"kind":2048,"name":"toJsonArray","url":"classes/buffer.html#tojsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":541,"kind":2048,"name":"getByte","url":"classes/buffer.html#getbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":542,"kind":2048,"name":"getUnsignedByte","url":"classes/buffer.html#getunsignedbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":543,"kind":2048,"name":"getInt","url":"classes/buffer.html#getint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":544,"kind":2048,"name":"getIntLE","url":"classes/buffer.html#getintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":545,"kind":2048,"name":"getUnsignedInt","url":"classes/buffer.html#getunsignedint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":546,"kind":2048,"name":"getUnsignedIntLE","url":"classes/buffer.html#getunsignedintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":547,"kind":2048,"name":"getLong","url":"classes/buffer.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":548,"kind":2048,"name":"getLongLE","url":"classes/buffer.html#getlongle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":549,"kind":2048,"name":"getDouble","url":"classes/buffer.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":550,"kind":2048,"name":"getFloat","url":"classes/buffer.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":551,"kind":2048,"name":"getShort","url":"classes/buffer.html#getshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":552,"kind":2048,"name":"getShortLE","url":"classes/buffer.html#getshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":553,"kind":2048,"name":"getUnsignedShort","url":"classes/buffer.html#getunsignedshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":554,"kind":2048,"name":"getUnsignedShortLE","url":"classes/buffer.html#getunsignedshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":555,"kind":2048,"name":"getMedium","url":"classes/buffer.html#getmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":556,"kind":2048,"name":"getMediumLE","url":"classes/buffer.html#getmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":557,"kind":2048,"name":"getUnsignedMedium","url":"classes/buffer.html#getunsignedmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":558,"kind":2048,"name":"getUnsignedMediumLE","url":"classes/buffer.html#getunsignedmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":559,"kind":2048,"name":"getBuffer","url":"classes/buffer.html#getbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":560,"kind":2048,"name":"getString","url":"classes/buffer.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":561,"kind":2048,"name":"appendBuffer","url":"classes/buffer.html#appendbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":562,"kind":2048,"name":"appendByte","url":"classes/buffer.html#appendbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":563,"kind":2048,"name":"appendUnsignedByte","url":"classes/buffer.html#appendunsignedbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":564,"kind":2048,"name":"appendInt","url":"classes/buffer.html#appendint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":565,"kind":2048,"name":"appendIntLE","url":"classes/buffer.html#appendintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":566,"kind":2048,"name":"appendUnsignedInt","url":"classes/buffer.html#appendunsignedint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":567,"kind":2048,"name":"appendUnsignedIntLE","url":"classes/buffer.html#appendunsignedintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":568,"kind":2048,"name":"appendMedium","url":"classes/buffer.html#appendmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":569,"kind":2048,"name":"appendMediumLE","url":"classes/buffer.html#appendmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":570,"kind":2048,"name":"appendLong","url":"classes/buffer.html#appendlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":571,"kind":2048,"name":"appendLongLE","url":"classes/buffer.html#appendlongle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":572,"kind":2048,"name":"appendShort","url":"classes/buffer.html#appendshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":573,"kind":2048,"name":"appendShortLE","url":"classes/buffer.html#appendshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":574,"kind":2048,"name":"appendUnsignedShort","url":"classes/buffer.html#appendunsignedshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":575,"kind":2048,"name":"appendUnsignedShortLE","url":"classes/buffer.html#appendunsignedshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":576,"kind":2048,"name":"appendFloat","url":"classes/buffer.html#appendfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":577,"kind":2048,"name":"appendDouble","url":"classes/buffer.html#appenddouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":578,"kind":2048,"name":"appendString","url":"classes/buffer.html#appendstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":579,"kind":2048,"name":"setByte","url":"classes/buffer.html#setbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":580,"kind":2048,"name":"setUnsignedByte","url":"classes/buffer.html#setunsignedbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":581,"kind":2048,"name":"setInt","url":"classes/buffer.html#setint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":582,"kind":2048,"name":"setIntLE","url":"classes/buffer.html#setintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":583,"kind":2048,"name":"setUnsignedInt","url":"classes/buffer.html#setunsignedint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":584,"kind":2048,"name":"setUnsignedIntLE","url":"classes/buffer.html#setunsignedintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":585,"kind":2048,"name":"setMedium","url":"classes/buffer.html#setmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":586,"kind":2048,"name":"setMediumLE","url":"classes/buffer.html#setmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":587,"kind":2048,"name":"setLong","url":"classes/buffer.html#setlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":588,"kind":2048,"name":"setLongLE","url":"classes/buffer.html#setlongle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":589,"kind":2048,"name":"setDouble","url":"classes/buffer.html#setdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":590,"kind":2048,"name":"setFloat","url":"classes/buffer.html#setfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":591,"kind":2048,"name":"setShort","url":"classes/buffer.html#setshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":592,"kind":2048,"name":"setShortLE","url":"classes/buffer.html#setshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":593,"kind":2048,"name":"setUnsignedShort","url":"classes/buffer.html#setunsignedshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":594,"kind":2048,"name":"setUnsignedShortLE","url":"classes/buffer.html#setunsignedshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":595,"kind":2048,"name":"setBuffer","url":"classes/buffer.html#setbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":596,"kind":2048,"name":"setString","url":"classes/buffer.html#setstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":597,"kind":2048,"name":"length","url":"classes/buffer.html#length","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":598,"kind":2048,"name":"copy","url":"classes/buffer.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":599,"kind":2048,"name":"slice","url":"classes/buffer.html#slice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":600,"kind":128,"name":"CLI","url":"classes/cli.html","classes":"tsd-kind-class"},{"id":601,"kind":2048,"name":"create","url":"classes/cli.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CLI"},{"id":602,"kind":2048,"name":"parse","url":"classes/cli.html#parse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":603,"kind":2048,"name":"getName","url":"classes/cli.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":604,"kind":2048,"name":"setName","url":"classes/cli.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":605,"kind":2048,"name":"getDescription","url":"classes/cli.html#getdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":606,"kind":2048,"name":"setDescription","url":"classes/cli.html#setdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":607,"kind":2048,"name":"getSummary","url":"classes/cli.html#getsummary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":608,"kind":2048,"name":"setSummary","url":"classes/cli.html#setsummary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":609,"kind":2048,"name":"isHidden","url":"classes/cli.html#ishidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":610,"kind":2048,"name":"setHidden","url":"classes/cli.html#sethidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":611,"kind":2048,"name":"getOptions","url":"classes/cli.html#getoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":612,"kind":2048,"name":"addOption","url":"classes/cli.html#addoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":613,"kind":2048,"name":"addOptions","url":"classes/cli.html#addoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":614,"kind":2048,"name":"setOptions","url":"classes/cli.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":615,"kind":2048,"name":"getArguments","url":"classes/cli.html#getarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":616,"kind":2048,"name":"addArgument","url":"classes/cli.html#addargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":617,"kind":2048,"name":"addArguments","url":"classes/cli.html#addarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":618,"kind":2048,"name":"setArguments","url":"classes/cli.html#setarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":619,"kind":2048,"name":"getOption","url":"classes/cli.html#getoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":620,"kind":2048,"name":"getArgument","url":"classes/cli.html#getargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":621,"kind":2048,"name":"removeOption","url":"classes/cli.html#removeoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":622,"kind":2048,"name":"removeArgument","url":"classes/cli.html#removeargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":623,"kind":128,"name":"CommandLine","url":"classes/commandline.html","classes":"tsd-kind-class"},{"id":624,"kind":2048,"name":"create","url":"classes/commandline.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandLine"},{"id":625,"kind":2048,"name":"cli","url":"classes/commandline.html#cli","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":626,"kind":2048,"name":"allArguments","url":"classes/commandline.html#allarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":627,"kind":2048,"name":"getOptionValue","url":"classes/commandline.html#getoptionvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":628,"kind":2048,"name":"getArgumentValue","url":"classes/commandline.html#getargumentvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":629,"kind":2048,"name":"isFlagEnabled","url":"classes/commandline.html#isflagenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":630,"kind":2048,"name":"isOptionAssigned","url":"classes/commandline.html#isoptionassigned","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":631,"kind":2048,"name":"getRawValues","url":"classes/commandline.html#getrawvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":632,"kind":2048,"name":"getRawValuesForOption","url":"classes/commandline.html#getrawvaluesforoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":633,"kind":2048,"name":"getRawValuesForArgument","url":"classes/commandline.html#getrawvaluesforargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":634,"kind":2048,"name":"getRawValueForOption","url":"classes/commandline.html#getrawvalueforoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":635,"kind":2048,"name":"acceptMoreValues","url":"classes/commandline.html#acceptmorevalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":636,"kind":2048,"name":"getRawValueForArgument","url":"classes/commandline.html#getrawvalueforargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":637,"kind":2048,"name":"isArgumentAssigned","url":"classes/commandline.html#isargumentassigned","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":638,"kind":2048,"name":"isSeenInCommandLine","url":"classes/commandline.html#isseenincommandline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":639,"kind":2048,"name":"isValid","url":"classes/commandline.html#isvalid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":640,"kind":2048,"name":"isAskingForHelp","url":"classes/commandline.html#isaskingforhelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":641,"kind":128,"name":"CompositeFuture","url":"classes/compositefuture.html","classes":"tsd-kind-class"},{"id":642,"kind":2048,"name":"complete","url":"classes/compositefuture.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":643,"kind":2048,"name":"tryComplete","url":"classes/compositefuture.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":644,"kind":2048,"name":"result","url":"classes/compositefuture.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":645,"kind":2048,"name":"compose","url":"classes/compositefuture.html#compose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":646,"kind":2048,"name":"map","url":"classes/compositefuture.html#map","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":647,"kind":2048,"name":"completer","url":"classes/compositefuture.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":648,"kind":2048,"name":"recover","url":"classes/compositefuture.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":649,"kind":2048,"name":"otherwise","url":"classes/compositefuture.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":650,"kind":2048,"name":"otherwiseEmpty","url":"classes/compositefuture.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":651,"kind":2048,"name":"all","url":"classes/compositefuture.html#all","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CompositeFuture"},{"id":652,"kind":2048,"name":"any","url":"classes/compositefuture.html#any","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CompositeFuture"},{"id":653,"kind":2048,"name":"join","url":"classes/compositefuture.html#join","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CompositeFuture"},{"id":654,"kind":2048,"name":"setHandler","url":"classes/compositefuture.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":655,"kind":2048,"name":"cause","url":"classes/compositefuture.html#cause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":656,"kind":2048,"name":"succeeded","url":"classes/compositefuture.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":657,"kind":2048,"name":"failed","url":"classes/compositefuture.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":658,"kind":2048,"name":"isComplete","url":"classes/compositefuture.html#iscomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":659,"kind":2048,"name":"resultAt","url":"classes/compositefuture.html#resultat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":660,"kind":2048,"name":"size","url":"classes/compositefuture.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":661,"kind":128,"name":"Context","url":"classes/context.html","classes":"tsd-kind-class"},{"id":662,"kind":2048,"name":"isOnWorkerThread","url":"classes/context.html#isonworkerthread","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Context"},{"id":663,"kind":2048,"name":"isOnEventLoopThread","url":"classes/context.html#isoneventloopthread","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Context"},{"id":664,"kind":2048,"name":"isOnVertxThread","url":"classes/context.html#isonvertxthread","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Context"},{"id":665,"kind":2048,"name":"runOnContext","url":"classes/context.html#runoncontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":666,"kind":2048,"name":"executeBlocking","url":"classes/context.html#executeblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":667,"kind":2048,"name":"deploymentID","url":"classes/context.html#deploymentid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":668,"kind":2048,"name":"config","url":"classes/context.html#config","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":669,"kind":2048,"name":"processArgs","url":"classes/context.html#processargs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":670,"kind":2048,"name":"isEventLoopContext","url":"classes/context.html#iseventloopcontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":671,"kind":2048,"name":"isWorkerContext","url":"classes/context.html#isworkercontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":672,"kind":2048,"name":"isMultiThreadedWorkerContext","url":"classes/context.html#ismultithreadedworkercontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":673,"kind":2048,"name":"get","url":"classes/context.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":674,"kind":2048,"name":"put","url":"classes/context.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":675,"kind":2048,"name":"remove","url":"classes/context.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":676,"kind":2048,"name":"owner","url":"classes/context.html#owner","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":677,"kind":2048,"name":"getInstanceCount","url":"classes/context.html#getinstancecount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":678,"kind":2048,"name":"exceptionHandler","url":"classes/context.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":679,"kind":128,"name":"Counter","url":"classes/counter.html","classes":"tsd-kind-class"},{"id":680,"kind":2048,"name":"get","url":"classes/counter.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":681,"kind":2048,"name":"incrementAndGet","url":"classes/counter.html#incrementandget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":682,"kind":2048,"name":"getAndIncrement","url":"classes/counter.html#getandincrement","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":683,"kind":2048,"name":"decrementAndGet","url":"classes/counter.html#decrementandget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":684,"kind":2048,"name":"addAndGet","url":"classes/counter.html#addandget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":685,"kind":2048,"name":"getAndAdd","url":"classes/counter.html#getandadd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":686,"kind":2048,"name":"compareAndSet","url":"classes/counter.html#compareandset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":687,"kind":128,"name":"DatagramPacket","url":"classes/datagrampacket.html","classes":"tsd-kind-class"},{"id":688,"kind":2048,"name":"sender","url":"classes/datagrampacket.html#sender","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramPacket"},{"id":689,"kind":2048,"name":"data","url":"classes/datagrampacket.html#data","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramPacket"},{"id":690,"kind":128,"name":"DatagramSocket","url":"classes/datagramsocket.html","classes":"tsd-kind-class"},{"id":691,"kind":2048,"name":"isMetricsEnabled","url":"classes/datagramsocket.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":692,"kind":2048,"name":"send","url":"classes/datagramsocket.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":693,"kind":2048,"name":"sender","url":"classes/datagramsocket.html#sender","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":694,"kind":2048,"name":"close","url":"classes/datagramsocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":695,"kind":2048,"name":"localAddress","url":"classes/datagramsocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":696,"kind":2048,"name":"listenMulticastGroup","url":"classes/datagramsocket.html#listenmulticastgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":697,"kind":2048,"name":"unlistenMulticastGroup","url":"classes/datagramsocket.html#unlistenmulticastgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":698,"kind":2048,"name":"blockMulticastGroup","url":"classes/datagramsocket.html#blockmulticastgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":699,"kind":2048,"name":"listen","url":"classes/datagramsocket.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":700,"kind":2048,"name":"pause","url":"classes/datagramsocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":701,"kind":2048,"name":"resume","url":"classes/datagramsocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":702,"kind":2048,"name":"endHandler","url":"classes/datagramsocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":703,"kind":2048,"name":"handler","url":"classes/datagramsocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":704,"kind":2048,"name":"exceptionHandler","url":"classes/datagramsocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":705,"kind":128,"name":"DnsClient","url":"classes/dnsclient.html","classes":"tsd-kind-class"},{"id":706,"kind":2048,"name":"lookup","url":"classes/dnsclient.html#lookup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":707,"kind":2048,"name":"lookup4","url":"classes/dnsclient.html#lookup4","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":708,"kind":2048,"name":"lookup6","url":"classes/dnsclient.html#lookup6","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":709,"kind":2048,"name":"resolveA","url":"classes/dnsclient.html#resolvea","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":710,"kind":2048,"name":"resolveAAAA","url":"classes/dnsclient.html#resolveaaaa","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":711,"kind":2048,"name":"resolveCNAME","url":"classes/dnsclient.html#resolvecname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":712,"kind":2048,"name":"resolveMX","url":"classes/dnsclient.html#resolvemx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":713,"kind":2048,"name":"resolveTXT","url":"classes/dnsclient.html#resolvetxt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":714,"kind":2048,"name":"resolvePTR","url":"classes/dnsclient.html#resolveptr","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":715,"kind":2048,"name":"resolveNS","url":"classes/dnsclient.html#resolvens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":716,"kind":2048,"name":"resolveSRV","url":"classes/dnsclient.html#resolvesrv","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":717,"kind":2048,"name":"reverseLookup","url":"classes/dnsclient.html#reverselookup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":718,"kind":128,"name":"EventBus","url":"classes/eventbus.html","classes":"tsd-kind-class"},{"id":719,"kind":2048,"name":"isMetricsEnabled","url":"classes/eventbus.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":720,"kind":2048,"name":"send","url":"classes/eventbus.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":721,"kind":2048,"name":"publish","url":"classes/eventbus.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":722,"kind":2048,"name":"consumer","url":"classes/eventbus.html#consumer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":723,"kind":2048,"name":"localConsumer","url":"classes/eventbus.html#localconsumer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":724,"kind":2048,"name":"sender","url":"classes/eventbus.html#sender","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":725,"kind":2048,"name":"publisher","url":"classes/eventbus.html#publisher","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":726,"kind":2048,"name":"addInterceptor","url":"classes/eventbus.html#addinterceptor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":727,"kind":2048,"name":"removeInterceptor","url":"classes/eventbus.html#removeinterceptor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":728,"kind":128,"name":"FileProps","url":"classes/fileprops.html","classes":"tsd-kind-class"},{"id":729,"kind":2048,"name":"creationTime","url":"classes/fileprops.html#creationtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":730,"kind":2048,"name":"lastAccessTime","url":"classes/fileprops.html#lastaccesstime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":731,"kind":2048,"name":"lastModifiedTime","url":"classes/fileprops.html#lastmodifiedtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":732,"kind":2048,"name":"isDirectory","url":"classes/fileprops.html#isdirectory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":733,"kind":2048,"name":"isOther","url":"classes/fileprops.html#isother","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":734,"kind":2048,"name":"isRegularFile","url":"classes/fileprops.html#isregularfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":735,"kind":2048,"name":"isSymbolicLink","url":"classes/fileprops.html#issymboliclink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":736,"kind":2048,"name":"size","url":"classes/fileprops.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":737,"kind":128,"name":"FileSystem","url":"classes/filesystem.html","classes":"tsd-kind-class"},{"id":738,"kind":2048,"name":"copy","url":"classes/filesystem.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":739,"kind":2048,"name":"copyBlocking","url":"classes/filesystem.html#copyblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":740,"kind":2048,"name":"copyRecursive","url":"classes/filesystem.html#copyrecursive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":741,"kind":2048,"name":"copyRecursiveBlocking","url":"classes/filesystem.html#copyrecursiveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":742,"kind":2048,"name":"move","url":"classes/filesystem.html#move","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":743,"kind":2048,"name":"moveBlocking","url":"classes/filesystem.html#moveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":744,"kind":2048,"name":"truncate","url":"classes/filesystem.html#truncate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":745,"kind":2048,"name":"truncateBlocking","url":"classes/filesystem.html#truncateblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":746,"kind":2048,"name":"chmod","url":"classes/filesystem.html#chmod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":747,"kind":2048,"name":"chmodBlocking","url":"classes/filesystem.html#chmodblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":748,"kind":2048,"name":"chmodRecursive","url":"classes/filesystem.html#chmodrecursive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":749,"kind":2048,"name":"chmodRecursiveBlocking","url":"classes/filesystem.html#chmodrecursiveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":750,"kind":2048,"name":"chown","url":"classes/filesystem.html#chown","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":751,"kind":2048,"name":"chownBlocking","url":"classes/filesystem.html#chownblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":752,"kind":2048,"name":"props","url":"classes/filesystem.html#props","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":753,"kind":2048,"name":"propsBlocking","url":"classes/filesystem.html#propsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":754,"kind":2048,"name":"lprops","url":"classes/filesystem.html#lprops","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":755,"kind":2048,"name":"lpropsBlocking","url":"classes/filesystem.html#lpropsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":756,"kind":2048,"name":"link","url":"classes/filesystem.html#link","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":757,"kind":2048,"name":"linkBlocking","url":"classes/filesystem.html#linkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":758,"kind":2048,"name":"symlink","url":"classes/filesystem.html#symlink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":759,"kind":2048,"name":"symlinkBlocking","url":"classes/filesystem.html#symlinkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":760,"kind":2048,"name":"unlink","url":"classes/filesystem.html#unlink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":761,"kind":2048,"name":"unlinkBlocking","url":"classes/filesystem.html#unlinkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":762,"kind":2048,"name":"readSymlink","url":"classes/filesystem.html#readsymlink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":763,"kind":2048,"name":"readSymlinkBlocking","url":"classes/filesystem.html#readsymlinkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":764,"kind":2048,"name":"delete","url":"classes/filesystem.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":765,"kind":2048,"name":"deleteBlocking","url":"classes/filesystem.html#deleteblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":766,"kind":2048,"name":"deleteRecursive","url":"classes/filesystem.html#deleterecursive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":767,"kind":2048,"name":"deleteRecursiveBlocking","url":"classes/filesystem.html#deleterecursiveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":768,"kind":2048,"name":"mkdir","url":"classes/filesystem.html#mkdir","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":769,"kind":2048,"name":"mkdirBlocking","url":"classes/filesystem.html#mkdirblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":770,"kind":2048,"name":"mkdirs","url":"classes/filesystem.html#mkdirs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":771,"kind":2048,"name":"mkdirsBlocking","url":"classes/filesystem.html#mkdirsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":772,"kind":2048,"name":"readDir","url":"classes/filesystem.html#readdir","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":773,"kind":2048,"name":"readDirBlocking","url":"classes/filesystem.html#readdirblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":774,"kind":2048,"name":"readFile","url":"classes/filesystem.html#readfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":775,"kind":2048,"name":"readFileBlocking","url":"classes/filesystem.html#readfileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":776,"kind":2048,"name":"writeFile","url":"classes/filesystem.html#writefile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":777,"kind":2048,"name":"writeFileBlocking","url":"classes/filesystem.html#writefileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":778,"kind":2048,"name":"open","url":"classes/filesystem.html#open","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":779,"kind":2048,"name":"openBlocking","url":"classes/filesystem.html#openblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":780,"kind":2048,"name":"createFile","url":"classes/filesystem.html#createfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":781,"kind":2048,"name":"createFileBlocking","url":"classes/filesystem.html#createfileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":782,"kind":2048,"name":"exists","url":"classes/filesystem.html#exists","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":783,"kind":2048,"name":"existsBlocking","url":"classes/filesystem.html#existsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":784,"kind":2048,"name":"fsProps","url":"classes/filesystem.html#fsprops","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":785,"kind":2048,"name":"fsPropsBlocking","url":"classes/filesystem.html#fspropsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":786,"kind":128,"name":"FileSystemProps","url":"classes/filesystemprops.html","classes":"tsd-kind-class"},{"id":787,"kind":2048,"name":"totalSpace","url":"classes/filesystemprops.html#totalspace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemProps"},{"id":788,"kind":2048,"name":"unallocatedSpace","url":"classes/filesystemprops.html#unallocatedspace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemProps"},{"id":789,"kind":2048,"name":"usableSpace","url":"classes/filesystemprops.html#usablespace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemProps"},{"id":790,"kind":128,"name":"Future","url":"classes/future.html","classes":"tsd-kind-class"},{"id":791,"kind":2048,"name":"future","url":"classes/future.html#future-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Future"},{"id":792,"kind":2048,"name":"succeededFuture","url":"classes/future.html#succeededfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Future"},{"id":793,"kind":2048,"name":"failedFuture","url":"classes/future.html#failedfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Future"},{"id":794,"kind":2048,"name":"isComplete","url":"classes/future.html#iscomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":795,"kind":2048,"name":"setHandler","url":"classes/future.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":796,"kind":2048,"name":"complete","url":"classes/future.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":797,"kind":2048,"name":"fail","url":"classes/future.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":798,"kind":2048,"name":"tryComplete","url":"classes/future.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":799,"kind":2048,"name":"tryFail","url":"classes/future.html#tryfail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":800,"kind":2048,"name":"result","url":"classes/future.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":801,"kind":2048,"name":"cause","url":"classes/future.html#cause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":802,"kind":2048,"name":"succeeded","url":"classes/future.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":803,"kind":2048,"name":"failed","url":"classes/future.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":804,"kind":2048,"name":"compose","url":"classes/future.html#compose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":805,"kind":2048,"name":"map","url":"classes/future.html#map","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":806,"kind":2048,"name":"mapEmpty","url":"classes/future.html#mapempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":807,"kind":2048,"name":"completer","url":"classes/future.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":808,"kind":2048,"name":"recover","url":"classes/future.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":809,"kind":2048,"name":"otherwise","url":"classes/future.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":810,"kind":2048,"name":"otherwiseEmpty","url":"classes/future.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":811,"kind":128,"name":"HttpClient","url":"classes/httpclient.html","classes":"tsd-kind-class"},{"id":812,"kind":2048,"name":"isMetricsEnabled","url":"classes/httpclient.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":813,"kind":2048,"name":"request","url":"classes/httpclient.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":814,"kind":2048,"name":"requestAbs","url":"classes/httpclient.html#requestabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":815,"kind":2048,"name":"get","url":"classes/httpclient.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":816,"kind":2048,"name":"getAbs","url":"classes/httpclient.html#getabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":817,"kind":2048,"name":"getNow","url":"classes/httpclient.html#getnow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":818,"kind":2048,"name":"post","url":"classes/httpclient.html#post","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":819,"kind":2048,"name":"postAbs","url":"classes/httpclient.html#postabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":820,"kind":2048,"name":"head","url":"classes/httpclient.html#head","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":821,"kind":2048,"name":"headAbs","url":"classes/httpclient.html#headabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":822,"kind":2048,"name":"headNow","url":"classes/httpclient.html#headnow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":823,"kind":2048,"name":"options","url":"classes/httpclient.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":824,"kind":2048,"name":"optionsAbs","url":"classes/httpclient.html#optionsabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":825,"kind":2048,"name":"optionsNow","url":"classes/httpclient.html#optionsnow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":826,"kind":2048,"name":"put","url":"classes/httpclient.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":827,"kind":2048,"name":"putAbs","url":"classes/httpclient.html#putabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":828,"kind":2048,"name":"delete","url":"classes/httpclient.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":829,"kind":2048,"name":"deleteAbs","url":"classes/httpclient.html#deleteabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":830,"kind":2048,"name":"websocket","url":"classes/httpclient.html#websocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":831,"kind":2048,"name":"websocketAbs","url":"classes/httpclient.html#websocketabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":832,"kind":2048,"name":"websocketStream","url":"classes/httpclient.html#websocketstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":833,"kind":2048,"name":"websocketStreamAbs","url":"classes/httpclient.html#websocketstreamabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":834,"kind":2048,"name":"redirectHandler","url":"classes/httpclient.html#redirecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":835,"kind":2048,"name":"close","url":"classes/httpclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":836,"kind":128,"name":"HttpClientRequest","url":"classes/httpclientrequest.html","classes":"tsd-kind-class"},{"id":837,"kind":2048,"name":"writeQueueFull","url":"classes/httpclientrequest.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":838,"kind":2048,"name":"exceptionHandler","url":"classes/httpclientrequest.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":839,"kind":2048,"name":"write","url":"classes/httpclientrequest.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":840,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/httpclientrequest.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":841,"kind":2048,"name":"drainHandler","url":"classes/httpclientrequest.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":842,"kind":2048,"name":"handler","url":"classes/httpclientrequest.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":843,"kind":2048,"name":"pause","url":"classes/httpclientrequest.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":844,"kind":2048,"name":"resume","url":"classes/httpclientrequest.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":845,"kind":2048,"name":"endHandler","url":"classes/httpclientrequest.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":846,"kind":2048,"name":"setFollowRedirects","url":"classes/httpclientrequest.html#setfollowredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":847,"kind":2048,"name":"setChunked","url":"classes/httpclientrequest.html#setchunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":848,"kind":2048,"name":"isChunked","url":"classes/httpclientrequest.html#ischunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":849,"kind":2048,"name":"method","url":"classes/httpclientrequest.html#method","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":850,"kind":2048,"name":"getRawMethod","url":"classes/httpclientrequest.html#getrawmethod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":851,"kind":2048,"name":"setRawMethod","url":"classes/httpclientrequest.html#setrawmethod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":852,"kind":2048,"name":"absoluteURI","url":"classes/httpclientrequest.html#absoluteuri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":853,"kind":2048,"name":"uri","url":"classes/httpclientrequest.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":854,"kind":2048,"name":"path","url":"classes/httpclientrequest.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":855,"kind":2048,"name":"query","url":"classes/httpclientrequest.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":856,"kind":2048,"name":"setHost","url":"classes/httpclientrequest.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":857,"kind":2048,"name":"getHost","url":"classes/httpclientrequest.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":858,"kind":2048,"name":"headers","url":"classes/httpclientrequest.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":859,"kind":2048,"name":"putHeader","url":"classes/httpclientrequest.html#putheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":860,"kind":2048,"name":"continueHandler","url":"classes/httpclientrequest.html#continuehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":861,"kind":2048,"name":"sendHead","url":"classes/httpclientrequest.html#sendhead","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":862,"kind":2048,"name":"end","url":"classes/httpclientrequest.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":863,"kind":2048,"name":"setTimeout","url":"classes/httpclientrequest.html#settimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":864,"kind":2048,"name":"pushHandler","url":"classes/httpclientrequest.html#pushhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":865,"kind":2048,"name":"reset","url":"classes/httpclientrequest.html#reset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":866,"kind":2048,"name":"connection","url":"classes/httpclientrequest.html#connection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":867,"kind":2048,"name":"connectionHandler","url":"classes/httpclientrequest.html#connectionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":868,"kind":2048,"name":"writeCustomFrame","url":"classes/httpclientrequest.html#writecustomframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":869,"kind":2048,"name":"streamId","url":"classes/httpclientrequest.html#streamid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":870,"kind":128,"name":"HttpClientResponse","url":"classes/httpclientresponse.html","classes":"tsd-kind-class"},{"id":871,"kind":2048,"name":"resume","url":"classes/httpclientresponse.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":872,"kind":2048,"name":"exceptionHandler","url":"classes/httpclientresponse.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":873,"kind":2048,"name":"handler","url":"classes/httpclientresponse.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":874,"kind":2048,"name":"pause","url":"classes/httpclientresponse.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":875,"kind":2048,"name":"endHandler","url":"classes/httpclientresponse.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":876,"kind":2048,"name":"version","url":"classes/httpclientresponse.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":877,"kind":2048,"name":"statusCode","url":"classes/httpclientresponse.html#statuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":878,"kind":2048,"name":"statusMessage","url":"classes/httpclientresponse.html#statusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":879,"kind":2048,"name":"headers","url":"classes/httpclientresponse.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":880,"kind":2048,"name":"getHeader","url":"classes/httpclientresponse.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":881,"kind":2048,"name":"getTrailer","url":"classes/httpclientresponse.html#gettrailer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":882,"kind":2048,"name":"trailers","url":"classes/httpclientresponse.html#trailers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":883,"kind":2048,"name":"cookies","url":"classes/httpclientresponse.html#cookies","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":884,"kind":2048,"name":"bodyHandler","url":"classes/httpclientresponse.html#bodyhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":885,"kind":2048,"name":"customFrameHandler","url":"classes/httpclientresponse.html#customframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":886,"kind":2048,"name":"netSocket","url":"classes/httpclientresponse.html#netsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":887,"kind":2048,"name":"request","url":"classes/httpclientresponse.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":888,"kind":128,"name":"HttpConnection","url":"classes/httpconnection.html","classes":"tsd-kind-class"},{"id":889,"kind":2048,"name":"getWindowSize","url":"classes/httpconnection.html#getwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":890,"kind":2048,"name":"setWindowSize","url":"classes/httpconnection.html#setwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":891,"kind":2048,"name":"goAway","url":"classes/httpconnection.html#goaway","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":892,"kind":2048,"name":"goAwayHandler","url":"classes/httpconnection.html#goawayhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":893,"kind":2048,"name":"shutdownHandler","url":"classes/httpconnection.html#shutdownhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":894,"kind":2048,"name":"shutdown","url":"classes/httpconnection.html#shutdown","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":895,"kind":2048,"name":"closeHandler","url":"classes/httpconnection.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":896,"kind":2048,"name":"close","url":"classes/httpconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":897,"kind":2048,"name":"settings","url":"classes/httpconnection.html#settings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":898,"kind":2048,"name":"updateSettings","url":"classes/httpconnection.html#updatesettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":899,"kind":2048,"name":"remoteSettings","url":"classes/httpconnection.html#remotesettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":900,"kind":2048,"name":"remoteSettingsHandler","url":"classes/httpconnection.html#remotesettingshandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":901,"kind":2048,"name":"ping","url":"classes/httpconnection.html#ping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":902,"kind":2048,"name":"pingHandler","url":"classes/httpconnection.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":903,"kind":2048,"name":"exceptionHandler","url":"classes/httpconnection.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":904,"kind":2048,"name":"remoteAddress","url":"classes/httpconnection.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":905,"kind":2048,"name":"localAddress","url":"classes/httpconnection.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":906,"kind":2048,"name":"isSsl","url":"classes/httpconnection.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":907,"kind":2048,"name":"indicatedServerName","url":"classes/httpconnection.html#indicatedservername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":908,"kind":128,"name":"HttpFrame","url":"classes/httpframe.html","classes":"tsd-kind-class"},{"id":909,"kind":2048,"name":"type","url":"classes/httpframe.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpFrame"},{"id":910,"kind":2048,"name":"flags","url":"classes/httpframe.html#flags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpFrame"},{"id":911,"kind":2048,"name":"payload","url":"classes/httpframe.html#payload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpFrame"},{"id":912,"kind":128,"name":"HttpServer","url":"classes/httpserver.html","classes":"tsd-kind-class"},{"id":913,"kind":2048,"name":"isMetricsEnabled","url":"classes/httpserver.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":914,"kind":2048,"name":"requestStream","url":"classes/httpserver.html#requeststream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":915,"kind":2048,"name":"requestHandler","url":"classes/httpserver.html#requesthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":916,"kind":2048,"name":"connectionHandler","url":"classes/httpserver.html#connectionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":917,"kind":2048,"name":"exceptionHandler","url":"classes/httpserver.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":918,"kind":2048,"name":"websocketStream","url":"classes/httpserver.html#websocketstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":919,"kind":2048,"name":"websocketHandler","url":"classes/httpserver.html#websockethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":920,"kind":2048,"name":"listen","url":"classes/httpserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":921,"kind":2048,"name":"close","url":"classes/httpserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":922,"kind":2048,"name":"actualPort","url":"classes/httpserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":923,"kind":128,"name":"HttpServerFileUpload","url":"classes/httpserverfileupload.html","classes":"tsd-kind-class"},{"id":924,"kind":2048,"name":"exceptionHandler","url":"classes/httpserverfileupload.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":925,"kind":2048,"name":"handler","url":"classes/httpserverfileupload.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":926,"kind":2048,"name":"endHandler","url":"classes/httpserverfileupload.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":927,"kind":2048,"name":"pause","url":"classes/httpserverfileupload.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":928,"kind":2048,"name":"resume","url":"classes/httpserverfileupload.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":929,"kind":2048,"name":"streamToFileSystem","url":"classes/httpserverfileupload.html#streamtofilesystem","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":930,"kind":2048,"name":"filename","url":"classes/httpserverfileupload.html#filename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":931,"kind":2048,"name":"name","url":"classes/httpserverfileupload.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":932,"kind":2048,"name":"contentType","url":"classes/httpserverfileupload.html#contenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":933,"kind":2048,"name":"contentTransferEncoding","url":"classes/httpserverfileupload.html#contenttransferencoding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":934,"kind":2048,"name":"charset","url":"classes/httpserverfileupload.html#charset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":935,"kind":2048,"name":"size","url":"classes/httpserverfileupload.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":936,"kind":2048,"name":"isSizeAvailable","url":"classes/httpserverfileupload.html#issizeavailable","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":937,"kind":128,"name":"HttpServerRequest","url":"classes/httpserverrequest.html","classes":"tsd-kind-class"},{"id":938,"kind":2048,"name":"exceptionHandler","url":"classes/httpserverrequest.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":939,"kind":2048,"name":"handler","url":"classes/httpserverrequest.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":940,"kind":2048,"name":"pause","url":"classes/httpserverrequest.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":941,"kind":2048,"name":"resume","url":"classes/httpserverrequest.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":942,"kind":2048,"name":"endHandler","url":"classes/httpserverrequest.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":943,"kind":2048,"name":"version","url":"classes/httpserverrequest.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":944,"kind":2048,"name":"method","url":"classes/httpserverrequest.html#method","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":945,"kind":2048,"name":"rawMethod","url":"classes/httpserverrequest.html#rawmethod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":946,"kind":2048,"name":"isSSL","url":"classes/httpserverrequest.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":947,"kind":2048,"name":"scheme","url":"classes/httpserverrequest.html#scheme","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":948,"kind":2048,"name":"uri","url":"classes/httpserverrequest.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":949,"kind":2048,"name":"path","url":"classes/httpserverrequest.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":950,"kind":2048,"name":"query","url":"classes/httpserverrequest.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":951,"kind":2048,"name":"host","url":"classes/httpserverrequest.html#host","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":952,"kind":2048,"name":"response","url":"classes/httpserverrequest.html#response","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":953,"kind":2048,"name":"headers","url":"classes/httpserverrequest.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":954,"kind":2048,"name":"getHeader","url":"classes/httpserverrequest.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":955,"kind":2048,"name":"params","url":"classes/httpserverrequest.html#params","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":956,"kind":2048,"name":"getParam","url":"classes/httpserverrequest.html#getparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":957,"kind":2048,"name":"remoteAddress","url":"classes/httpserverrequest.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":958,"kind":2048,"name":"localAddress","url":"classes/httpserverrequest.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":959,"kind":2048,"name":"absoluteURI","url":"classes/httpserverrequest.html#absoluteuri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":960,"kind":2048,"name":"bodyHandler","url":"classes/httpserverrequest.html#bodyhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":961,"kind":2048,"name":"netSocket","url":"classes/httpserverrequest.html#netsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":962,"kind":2048,"name":"setExpectMultipart","url":"classes/httpserverrequest.html#setexpectmultipart","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":963,"kind":2048,"name":"isExpectMultipart","url":"classes/httpserverrequest.html#isexpectmultipart","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":964,"kind":2048,"name":"uploadHandler","url":"classes/httpserverrequest.html#uploadhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":965,"kind":2048,"name":"formAttributes","url":"classes/httpserverrequest.html#formattributes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":966,"kind":2048,"name":"getFormAttribute","url":"classes/httpserverrequest.html#getformattribute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":967,"kind":2048,"name":"upgrade","url":"classes/httpserverrequest.html#upgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":968,"kind":2048,"name":"isEnded","url":"classes/httpserverrequest.html#isended","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":969,"kind":2048,"name":"customFrameHandler","url":"classes/httpserverrequest.html#customframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":970,"kind":2048,"name":"connection","url":"classes/httpserverrequest.html#connection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":971,"kind":128,"name":"HttpServerResponse","url":"classes/httpserverresponse.html","classes":"tsd-kind-class"},{"id":972,"kind":2048,"name":"writeQueueFull","url":"classes/httpserverresponse.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":973,"kind":2048,"name":"exceptionHandler","url":"classes/httpserverresponse.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":974,"kind":2048,"name":"write","url":"classes/httpserverresponse.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":975,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/httpserverresponse.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":976,"kind":2048,"name":"drainHandler","url":"classes/httpserverresponse.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":977,"kind":2048,"name":"getStatusCode","url":"classes/httpserverresponse.html#getstatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":978,"kind":2048,"name":"setStatusCode","url":"classes/httpserverresponse.html#setstatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":979,"kind":2048,"name":"getStatusMessage","url":"classes/httpserverresponse.html#getstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":980,"kind":2048,"name":"setStatusMessage","url":"classes/httpserverresponse.html#setstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":981,"kind":2048,"name":"setChunked","url":"classes/httpserverresponse.html#setchunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":982,"kind":2048,"name":"isChunked","url":"classes/httpserverresponse.html#ischunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":983,"kind":2048,"name":"headers","url":"classes/httpserverresponse.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":984,"kind":2048,"name":"putHeader","url":"classes/httpserverresponse.html#putheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":985,"kind":2048,"name":"trailers","url":"classes/httpserverresponse.html#trailers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":986,"kind":2048,"name":"putTrailer","url":"classes/httpserverresponse.html#puttrailer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":987,"kind":2048,"name":"closeHandler","url":"classes/httpserverresponse.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":988,"kind":2048,"name":"endHandler","url":"classes/httpserverresponse.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":989,"kind":2048,"name":"writeContinue","url":"classes/httpserverresponse.html#writecontinue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":990,"kind":2048,"name":"end","url":"classes/httpserverresponse.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":991,"kind":2048,"name":"sendFile","url":"classes/httpserverresponse.html#sendfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":992,"kind":2048,"name":"close","url":"classes/httpserverresponse.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":993,"kind":2048,"name":"ended","url":"classes/httpserverresponse.html#ended","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":994,"kind":2048,"name":"closed","url":"classes/httpserverresponse.html#closed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":995,"kind":2048,"name":"headWritten","url":"classes/httpserverresponse.html#headwritten","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":996,"kind":2048,"name":"headersEndHandler","url":"classes/httpserverresponse.html#headersendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":997,"kind":2048,"name":"bodyEndHandler","url":"classes/httpserverresponse.html#bodyendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":998,"kind":2048,"name":"bytesWritten","url":"classes/httpserverresponse.html#byteswritten","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":999,"kind":2048,"name":"streamId","url":"classes/httpserverresponse.html#streamid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1000,"kind":2048,"name":"push","url":"classes/httpserverresponse.html#push","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1001,"kind":2048,"name":"reset","url":"classes/httpserverresponse.html#reset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1002,"kind":2048,"name":"writeCustomFrame","url":"classes/httpserverresponse.html#writecustomframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1003,"kind":128,"name":"JsonEvent","url":"classes/jsonevent.html","classes":"tsd-kind-class"},{"id":1004,"kind":2048,"name":"type","url":"classes/jsonevent.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1005,"kind":2048,"name":"fieldName","url":"classes/jsonevent.html#fieldname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1006,"kind":2048,"name":"value","url":"classes/jsonevent.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1007,"kind":2048,"name":"isNumber","url":"classes/jsonevent.html#isnumber","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1008,"kind":2048,"name":"integerValue","url":"classes/jsonevent.html#integervalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1009,"kind":2048,"name":"longValue","url":"classes/jsonevent.html#longvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1010,"kind":2048,"name":"floatValue","url":"classes/jsonevent.html#floatvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1011,"kind":2048,"name":"doubleValue","url":"classes/jsonevent.html#doublevalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1012,"kind":2048,"name":"isBoolean","url":"classes/jsonevent.html#isboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1013,"kind":2048,"name":"booleanValue","url":"classes/jsonevent.html#booleanvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1014,"kind":2048,"name":"isString","url":"classes/jsonevent.html#isstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1015,"kind":2048,"name":"stringValue","url":"classes/jsonevent.html#stringvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1016,"kind":2048,"name":"binaryValue","url":"classes/jsonevent.html#binaryvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1017,"kind":2048,"name":"isNull","url":"classes/jsonevent.html#isnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1018,"kind":2048,"name":"isObject","url":"classes/jsonevent.html#isobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1019,"kind":2048,"name":"objectValue","url":"classes/jsonevent.html#objectvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1020,"kind":2048,"name":"isArray","url":"classes/jsonevent.html#isarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1021,"kind":2048,"name":"arrayValue","url":"classes/jsonevent.html#arrayvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1022,"kind":2048,"name":"mapTo","url":"classes/jsonevent.html#mapto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1023,"kind":128,"name":"JsonParser","url":"classes/jsonparser.html","classes":"tsd-kind-class"},{"id":1024,"kind":2048,"name":"handle","url":"classes/jsonparser.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1025,"kind":2048,"name":"newParser","url":"classes/jsonparser.html#newparser","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JsonParser"},{"id":1026,"kind":2048,"name":"write","url":"classes/jsonparser.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1027,"kind":2048,"name":"end","url":"classes/jsonparser.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1028,"kind":2048,"name":"objectEventMode","url":"classes/jsonparser.html#objecteventmode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1029,"kind":2048,"name":"objectValueMode","url":"classes/jsonparser.html#objectvaluemode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1030,"kind":2048,"name":"arrayEventMode","url":"classes/jsonparser.html#arrayeventmode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1031,"kind":2048,"name":"arrayValueMode","url":"classes/jsonparser.html#arrayvaluemode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1032,"kind":2048,"name":"pause","url":"classes/jsonparser.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1033,"kind":2048,"name":"resume","url":"classes/jsonparser.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1034,"kind":2048,"name":"endHandler","url":"classes/jsonparser.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1035,"kind":2048,"name":"handler","url":"classes/jsonparser.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1036,"kind":2048,"name":"exceptionHandler","url":"classes/jsonparser.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1037,"kind":128,"name":"LocalMap","url":"classes/localmap.html","classes":"tsd-kind-class"},{"id":1038,"kind":2048,"name":"get","url":"classes/localmap.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1039,"kind":2048,"name":"put","url":"classes/localmap.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1040,"kind":2048,"name":"remove","url":"classes/localmap.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1041,"kind":2048,"name":"clear","url":"classes/localmap.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1042,"kind":2048,"name":"size","url":"classes/localmap.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1043,"kind":2048,"name":"isEmpty","url":"classes/localmap.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1044,"kind":2048,"name":"putIfAbsent","url":"classes/localmap.html#putifabsent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1045,"kind":2048,"name":"removeIfPresent","url":"classes/localmap.html#removeifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1046,"kind":2048,"name":"replaceIfPresent","url":"classes/localmap.html#replaceifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1047,"kind":2048,"name":"replace","url":"classes/localmap.html#replace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1048,"kind":2048,"name":"close","url":"classes/localmap.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1049,"kind":2048,"name":"containsKey","url":"classes/localmap.html#containskey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1050,"kind":2048,"name":"containsValue","url":"classes/localmap.html#containsvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1051,"kind":2048,"name":"getOrDefault","url":"classes/localmap.html#getordefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1052,"kind":128,"name":"Lock","url":"classes/lock.html","classes":"tsd-kind-class"},{"id":1053,"kind":2048,"name":"release","url":"classes/lock.html#release","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Lock"},{"id":1054,"kind":256,"name":"Measured","url":"interfaces/measured.html","classes":"tsd-kind-interface"},{"id":1055,"kind":2048,"name":"isMetricsEnabled","url":"interfaces/measured.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Measured"},{"id":1056,"kind":128,"name":"Message","url":"classes/message.html","classes":"tsd-kind-class"},{"id":1057,"kind":2048,"name":"address","url":"classes/message.html#address","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1058,"kind":2048,"name":"headers","url":"classes/message.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1059,"kind":2048,"name":"body","url":"classes/message.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1060,"kind":2048,"name":"replyAddress","url":"classes/message.html#replyaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1061,"kind":2048,"name":"isSend","url":"classes/message.html#issend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1062,"kind":2048,"name":"reply","url":"classes/message.html#reply","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1063,"kind":2048,"name":"fail","url":"classes/message.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1064,"kind":128,"name":"MessageConsumer","url":"classes/messageconsumer.html","classes":"tsd-kind-class"},{"id":1065,"kind":2048,"name":"exceptionHandler","url":"classes/messageconsumer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1066,"kind":2048,"name":"handler","url":"classes/messageconsumer.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1067,"kind":2048,"name":"pause","url":"classes/messageconsumer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1068,"kind":2048,"name":"resume","url":"classes/messageconsumer.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1069,"kind":2048,"name":"endHandler","url":"classes/messageconsumer.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1070,"kind":2048,"name":"bodyStream","url":"classes/messageconsumer.html#bodystream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1071,"kind":2048,"name":"isRegistered","url":"classes/messageconsumer.html#isregistered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1072,"kind":2048,"name":"address","url":"classes/messageconsumer.html#address","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1073,"kind":2048,"name":"setMaxBufferedMessages","url":"classes/messageconsumer.html#setmaxbufferedmessages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1074,"kind":2048,"name":"getMaxBufferedMessages","url":"classes/messageconsumer.html#getmaxbufferedmessages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1075,"kind":2048,"name":"completionHandler","url":"classes/messageconsumer.html#completionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1076,"kind":2048,"name":"unregister","url":"classes/messageconsumer.html#unregister","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1077,"kind":128,"name":"MessageProducer","url":"classes/messageproducer.html","classes":"tsd-kind-class"},{"id":1078,"kind":2048,"name":"end","url":"classes/messageproducer.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1079,"kind":2048,"name":"writeQueueFull","url":"classes/messageproducer.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1080,"kind":2048,"name":"send","url":"classes/messageproducer.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1081,"kind":2048,"name":"exceptionHandler","url":"classes/messageproducer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1082,"kind":2048,"name":"write","url":"classes/messageproducer.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1083,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/messageproducer.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1084,"kind":2048,"name":"drainHandler","url":"classes/messageproducer.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1085,"kind":2048,"name":"deliveryOptions","url":"classes/messageproducer.html#deliveryoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1086,"kind":2048,"name":"address","url":"classes/messageproducer.html#address","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1087,"kind":2048,"name":"close","url":"classes/messageproducer.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1088,"kind":128,"name":"MultiMap","url":"classes/multimap.html","classes":"tsd-kind-class"},{"id":1089,"kind":2048,"name":"caseInsensitiveMultiMap","url":"classes/multimap.html#caseinsensitivemultimap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MultiMap"},{"id":1090,"kind":2048,"name":"get","url":"classes/multimap.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1091,"kind":2048,"name":"getAll","url":"classes/multimap.html#getall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1092,"kind":2048,"name":"contains","url":"classes/multimap.html#contains","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1093,"kind":2048,"name":"isEmpty","url":"classes/multimap.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1094,"kind":2048,"name":"names","url":"classes/multimap.html#names","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1095,"kind":2048,"name":"add","url":"classes/multimap.html#add","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1096,"kind":2048,"name":"addAll","url":"classes/multimap.html#addall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1097,"kind":2048,"name":"set","url":"classes/multimap.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1098,"kind":2048,"name":"setAll","url":"classes/multimap.html#setall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1099,"kind":2048,"name":"remove","url":"classes/multimap.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1100,"kind":2048,"name":"clear","url":"classes/multimap.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1101,"kind":2048,"name":"size","url":"classes/multimap.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1102,"kind":128,"name":"MxRecord","url":"classes/mxrecord.html","classes":"tsd-kind-class"},{"id":1103,"kind":2048,"name":"priority","url":"classes/mxrecord.html#priority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MxRecord"},{"id":1104,"kind":2048,"name":"name","url":"classes/mxrecord.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MxRecord"},{"id":1105,"kind":128,"name":"NetClient","url":"classes/netclient.html","classes":"tsd-kind-class"},{"id":1106,"kind":2048,"name":"isMetricsEnabled","url":"classes/netclient.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClient"},{"id":1107,"kind":2048,"name":"connect","url":"classes/netclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClient"},{"id":1108,"kind":2048,"name":"close","url":"classes/netclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClient"},{"id":1109,"kind":128,"name":"NetServer","url":"classes/netserver.html","classes":"tsd-kind-class"},{"id":1110,"kind":2048,"name":"isMetricsEnabled","url":"classes/netserver.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1111,"kind":2048,"name":"connectStream","url":"classes/netserver.html#connectstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1112,"kind":2048,"name":"connectHandler","url":"classes/netserver.html#connecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1113,"kind":2048,"name":"listen","url":"classes/netserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1114,"kind":2048,"name":"exceptionHandler","url":"classes/netserver.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1115,"kind":2048,"name":"close","url":"classes/netserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1116,"kind":2048,"name":"actualPort","url":"classes/netserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1117,"kind":128,"name":"NetSocket","url":"classes/netsocket.html","classes":"tsd-kind-class"},{"id":1118,"kind":2048,"name":"end","url":"classes/netsocket.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1119,"kind":2048,"name":"writeQueueFull","url":"classes/netsocket.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1120,"kind":2048,"name":"exceptionHandler","url":"classes/netsocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1121,"kind":2048,"name":"handler","url":"classes/netsocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1122,"kind":2048,"name":"pause","url":"classes/netsocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1123,"kind":2048,"name":"resume","url":"classes/netsocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1124,"kind":2048,"name":"endHandler","url":"classes/netsocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1125,"kind":2048,"name":"write","url":"classes/netsocket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1126,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/netsocket.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1127,"kind":2048,"name":"drainHandler","url":"classes/netsocket.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1128,"kind":2048,"name":"writeHandlerID","url":"classes/netsocket.html#writehandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1129,"kind":2048,"name":"sendFile","url":"classes/netsocket.html#sendfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1130,"kind":2048,"name":"remoteAddress","url":"classes/netsocket.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1131,"kind":2048,"name":"localAddress","url":"classes/netsocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1132,"kind":2048,"name":"close","url":"classes/netsocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1133,"kind":2048,"name":"closeHandler","url":"classes/netsocket.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1134,"kind":2048,"name":"upgradeToSsl","url":"classes/netsocket.html#upgradetossl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1135,"kind":2048,"name":"isSsl","url":"classes/netsocket.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1136,"kind":2048,"name":"indicatedServerName","url":"classes/netsocket.html#indicatedservername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1137,"kind":128,"name":"Pump","url":"classes/pump.html","classes":"tsd-kind-class"},{"id":1138,"kind":2048,"name":"pump","url":"classes/pump.html#pump-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Pump"},{"id":1139,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/pump.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1140,"kind":2048,"name":"start","url":"classes/pump.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1141,"kind":2048,"name":"stop","url":"classes/pump.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1142,"kind":2048,"name":"numberPumped","url":"classes/pump.html#numberpumped","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1143,"kind":256,"name":"ReadStream","url":"interfaces/readstream.html","classes":"tsd-kind-interface"},{"id":1144,"kind":2048,"name":"exceptionHandler","url":"interfaces/readstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1145,"kind":2048,"name":"handler","url":"interfaces/readstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1146,"kind":2048,"name":"pause","url":"interfaces/readstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1147,"kind":2048,"name":"resume","url":"interfaces/readstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1148,"kind":2048,"name":"endHandler","url":"interfaces/readstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1149,"kind":128,"name":"RecordParser","url":"classes/recordparser.html","classes":"tsd-kind-class"},{"id":1150,"kind":2048,"name":"setOutput","url":"classes/recordparser.html#setoutput","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1151,"kind":2048,"name":"newDelimited","url":"classes/recordparser.html#newdelimited","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RecordParser"},{"id":1152,"kind":2048,"name":"newFixed","url":"classes/recordparser.html#newfixed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RecordParser"},{"id":1153,"kind":2048,"name":"delimitedMode","url":"classes/recordparser.html#delimitedmode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1154,"kind":2048,"name":"fixedSizeMode","url":"classes/recordparser.html#fixedsizemode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1155,"kind":2048,"name":"maxRecordSize","url":"classes/recordparser.html#maxrecordsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1156,"kind":2048,"name":"handle","url":"classes/recordparser.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1157,"kind":2048,"name":"exceptionHandler","url":"classes/recordparser.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1158,"kind":2048,"name":"handler","url":"classes/recordparser.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1159,"kind":2048,"name":"pause","url":"classes/recordparser.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1160,"kind":2048,"name":"resume","url":"classes/recordparser.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1161,"kind":2048,"name":"endHandler","url":"classes/recordparser.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1162,"kind":128,"name":"SelfSignedCertificate","url":"classes/selfsignedcertificate.html","classes":"tsd-kind-class"},{"id":1163,"kind":2048,"name":"keyCertOptions","url":"classes/selfsignedcertificate.html#keycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1164,"kind":2048,"name":"trustOptions","url":"classes/selfsignedcertificate.html#trustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1165,"kind":2048,"name":"privateKeyPath","url":"classes/selfsignedcertificate.html#privatekeypath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1166,"kind":2048,"name":"certificatePath","url":"classes/selfsignedcertificate.html#certificatepath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1167,"kind":2048,"name":"delete","url":"classes/selfsignedcertificate.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1168,"kind":2048,"name":"create","url":"classes/selfsignedcertificate.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SelfSignedCertificate"},{"id":1169,"kind":128,"name":"SendContext","url":"classes/sendcontext.html","classes":"tsd-kind-class"},{"id":1170,"kind":2048,"name":"message","url":"classes/sendcontext.html#message","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SendContext"},{"id":1171,"kind":2048,"name":"next","url":"classes/sendcontext.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SendContext"},{"id":1172,"kind":2048,"name":"send","url":"classes/sendcontext.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SendContext"},{"id":1173,"kind":2048,"name":"sentBody","url":"classes/sendcontext.html#sentbody","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SendContext"},{"id":1174,"kind":128,"name":"ServerWebSocket","url":"classes/serverwebsocket.html","classes":"tsd-kind-class"},{"id":1175,"kind":2048,"name":"end","url":"classes/serverwebsocket.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1176,"kind":2048,"name":"writeQueueFull","url":"classes/serverwebsocket.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1177,"kind":2048,"name":"binaryHandlerID","url":"classes/serverwebsocket.html#binaryhandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1178,"kind":2048,"name":"textHandlerID","url":"classes/serverwebsocket.html#texthandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1179,"kind":2048,"name":"subProtocol","url":"classes/serverwebsocket.html#subprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1180,"kind":2048,"name":"writeTextMessage","url":"classes/serverwebsocket.html#writetextmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1181,"kind":2048,"name":"writePing","url":"classes/serverwebsocket.html#writeping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1182,"kind":2048,"name":"writePong","url":"classes/serverwebsocket.html#writepong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1183,"kind":2048,"name":"textMessageHandler","url":"classes/serverwebsocket.html#textmessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1184,"kind":2048,"name":"binaryMessageHandler","url":"classes/serverwebsocket.html#binarymessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1185,"kind":2048,"name":"pongHandler","url":"classes/serverwebsocket.html#ponghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1186,"kind":2048,"name":"close","url":"classes/serverwebsocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1187,"kind":2048,"name":"remoteAddress","url":"classes/serverwebsocket.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1188,"kind":2048,"name":"localAddress","url":"classes/serverwebsocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1189,"kind":2048,"name":"isSsl","url":"classes/serverwebsocket.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1190,"kind":2048,"name":"exceptionHandler","url":"classes/serverwebsocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1191,"kind":2048,"name":"handler","url":"classes/serverwebsocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1192,"kind":2048,"name":"pause","url":"classes/serverwebsocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1193,"kind":2048,"name":"resume","url":"classes/serverwebsocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1194,"kind":2048,"name":"endHandler","url":"classes/serverwebsocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1195,"kind":2048,"name":"write","url":"classes/serverwebsocket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1196,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/serverwebsocket.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1197,"kind":2048,"name":"drainHandler","url":"classes/serverwebsocket.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1198,"kind":2048,"name":"writeFrame","url":"classes/serverwebsocket.html#writeframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1199,"kind":2048,"name":"writeFinalTextFrame","url":"classes/serverwebsocket.html#writefinaltextframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1200,"kind":2048,"name":"writeFinalBinaryFrame","url":"classes/serverwebsocket.html#writefinalbinaryframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1201,"kind":2048,"name":"writeBinaryMessage","url":"classes/serverwebsocket.html#writebinarymessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1202,"kind":2048,"name":"closeHandler","url":"classes/serverwebsocket.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1203,"kind":2048,"name":"frameHandler","url":"classes/serverwebsocket.html#framehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1204,"kind":2048,"name":"uri","url":"classes/serverwebsocket.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1205,"kind":2048,"name":"path","url":"classes/serverwebsocket.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1206,"kind":2048,"name":"query","url":"classes/serverwebsocket.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1207,"kind":2048,"name":"headers","url":"classes/serverwebsocket.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1208,"kind":2048,"name":"accept","url":"classes/serverwebsocket.html#accept","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1209,"kind":2048,"name":"reject","url":"classes/serverwebsocket.html#reject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1210,"kind":128,"name":"SharedData","url":"classes/shareddata.html","classes":"tsd-kind-class"},{"id":1211,"kind":2048,"name":"getClusterWideMap","url":"classes/shareddata.html#getclusterwidemap","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1212,"kind":2048,"name":"getAsyncMap","url":"classes/shareddata.html#getasyncmap","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1213,"kind":2048,"name":"getLock","url":"classes/shareddata.html#getlock","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1214,"kind":2048,"name":"getLockWithTimeout","url":"classes/shareddata.html#getlockwithtimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1215,"kind":2048,"name":"getCounter","url":"classes/shareddata.html#getcounter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1216,"kind":2048,"name":"getLocalMap","url":"classes/shareddata.html#getlocalmap","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1217,"kind":128,"name":"SocketAddress","url":"classes/socketaddress.html","classes":"tsd-kind-class"},{"id":1218,"kind":2048,"name":"inetSocketAddress","url":"classes/socketaddress.html#inetsocketaddress","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SocketAddress"},{"id":1219,"kind":2048,"name":"domainSocketAddress","url":"classes/socketaddress.html#domainsocketaddress","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SocketAddress"},{"id":1220,"kind":2048,"name":"host","url":"classes/socketaddress.html#host","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SocketAddress"},{"id":1221,"kind":2048,"name":"port","url":"classes/socketaddress.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SocketAddress"},{"id":1222,"kind":2048,"name":"path","url":"classes/socketaddress.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SocketAddress"},{"id":1223,"kind":128,"name":"SrvRecord","url":"classes/srvrecord.html","classes":"tsd-kind-class"},{"id":1224,"kind":2048,"name":"priority","url":"classes/srvrecord.html#priority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1225,"kind":2048,"name":"weight","url":"classes/srvrecord.html#weight","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1226,"kind":2048,"name":"port","url":"classes/srvrecord.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1227,"kind":2048,"name":"name","url":"classes/srvrecord.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1228,"kind":2048,"name":"protocol","url":"classes/srvrecord.html#protocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1229,"kind":2048,"name":"service","url":"classes/srvrecord.html#service","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1230,"kind":2048,"name":"target","url":"classes/srvrecord.html#target","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1231,"kind":256,"name":"StreamBase","url":"interfaces/streambase.html","classes":"tsd-kind-interface"},{"id":1232,"kind":2048,"name":"exceptionHandler","url":"interfaces/streambase.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"StreamBase"},{"id":1233,"kind":128,"name":"TimeoutStream","url":"classes/timeoutstream.html","classes":"tsd-kind-class"},{"id":1234,"kind":2048,"name":"exceptionHandler","url":"classes/timeoutstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1235,"kind":2048,"name":"handler","url":"classes/timeoutstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1236,"kind":2048,"name":"pause","url":"classes/timeoutstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1237,"kind":2048,"name":"resume","url":"classes/timeoutstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1238,"kind":2048,"name":"endHandler","url":"classes/timeoutstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1239,"kind":2048,"name":"cancel","url":"classes/timeoutstream.html#cancel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1240,"kind":128,"name":"Vertx","url":"classes/vertx.html","classes":"tsd-kind-class"},{"id":1241,"kind":2048,"name":"isMetricsEnabled","url":"classes/vertx.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1242,"kind":2048,"name":"vertx","url":"classes/vertx.html#vertx-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Vertx"},{"id":1243,"kind":2048,"name":"clusteredVertx","url":"classes/vertx.html#clusteredvertx","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Vertx"},{"id":1244,"kind":2048,"name":"currentContext","url":"classes/vertx.html#currentcontext","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Vertx"},{"id":1245,"kind":2048,"name":"getOrCreateContext","url":"classes/vertx.html#getorcreatecontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1246,"kind":2048,"name":"createNetServer","url":"classes/vertx.html#createnetserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1247,"kind":2048,"name":"createNetClient","url":"classes/vertx.html#createnetclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1248,"kind":2048,"name":"createHttpServer","url":"classes/vertx.html#createhttpserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1249,"kind":2048,"name":"createHttpClient","url":"classes/vertx.html#createhttpclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1250,"kind":2048,"name":"createDatagramSocket","url":"classes/vertx.html#createdatagramsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1251,"kind":2048,"name":"fileSystem","url":"classes/vertx.html#filesystem","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1252,"kind":2048,"name":"eventBus","url":"classes/vertx.html#eventbus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1253,"kind":2048,"name":"createDnsClient","url":"classes/vertx.html#creatednsclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1254,"kind":2048,"name":"sharedData","url":"classes/vertx.html#shareddata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1255,"kind":2048,"name":"setTimer","url":"classes/vertx.html#settimer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1256,"kind":2048,"name":"timerStream","url":"classes/vertx.html#timerstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1257,"kind":2048,"name":"setPeriodic","url":"classes/vertx.html#setperiodic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1258,"kind":2048,"name":"periodicStream","url":"classes/vertx.html#periodicstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1259,"kind":2048,"name":"cancelTimer","url":"classes/vertx.html#canceltimer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1260,"kind":2048,"name":"runOnContext","url":"classes/vertx.html#runoncontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1261,"kind":2048,"name":"close","url":"classes/vertx.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1262,"kind":2048,"name":"deployVerticle","url":"classes/vertx.html#deployverticle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1263,"kind":2048,"name":"undeploy","url":"classes/vertx.html#undeploy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1264,"kind":2048,"name":"deploymentIDs","url":"classes/vertx.html#deploymentids","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1265,"kind":2048,"name":"isClustered","url":"classes/vertx.html#isclustered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1266,"kind":2048,"name":"executeBlocking","url":"classes/vertx.html#executeblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1267,"kind":2048,"name":"createSharedWorkerExecutor","url":"classes/vertx.html#createsharedworkerexecutor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1268,"kind":2048,"name":"isNativeTransportEnabled","url":"classes/vertx.html#isnativetransportenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1269,"kind":2048,"name":"exceptionHandler","url":"classes/vertx.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1270,"kind":128,"name":"WebSocket","url":"classes/websocket.html","classes":"tsd-kind-class"},{"id":1271,"kind":2048,"name":"end","url":"classes/websocket.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1272,"kind":2048,"name":"writeQueueFull","url":"classes/websocket.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1273,"kind":2048,"name":"binaryHandlerID","url":"classes/websocket.html#binaryhandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1274,"kind":2048,"name":"textHandlerID","url":"classes/websocket.html#texthandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1275,"kind":2048,"name":"subProtocol","url":"classes/websocket.html#subprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1276,"kind":2048,"name":"writePing","url":"classes/websocket.html#writeping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1277,"kind":2048,"name":"writePong","url":"classes/websocket.html#writepong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1278,"kind":2048,"name":"textMessageHandler","url":"classes/websocket.html#textmessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1279,"kind":2048,"name":"binaryMessageHandler","url":"classes/websocket.html#binarymessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1280,"kind":2048,"name":"pongHandler","url":"classes/websocket.html#ponghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1281,"kind":2048,"name":"close","url":"classes/websocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1282,"kind":2048,"name":"remoteAddress","url":"classes/websocket.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1283,"kind":2048,"name":"localAddress","url":"classes/websocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1284,"kind":2048,"name":"isSsl","url":"classes/websocket.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1285,"kind":2048,"name":"exceptionHandler","url":"classes/websocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1286,"kind":2048,"name":"handler","url":"classes/websocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1287,"kind":2048,"name":"pause","url":"classes/websocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1288,"kind":2048,"name":"resume","url":"classes/websocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1289,"kind":2048,"name":"endHandler","url":"classes/websocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1290,"kind":2048,"name":"write","url":"classes/websocket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1291,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/websocket.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1292,"kind":2048,"name":"drainHandler","url":"classes/websocket.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1293,"kind":2048,"name":"writeFrame","url":"classes/websocket.html#writeframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1294,"kind":2048,"name":"writeFinalTextFrame","url":"classes/websocket.html#writefinaltextframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1295,"kind":2048,"name":"writeFinalBinaryFrame","url":"classes/websocket.html#writefinalbinaryframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1296,"kind":2048,"name":"writeBinaryMessage","url":"classes/websocket.html#writebinarymessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1297,"kind":2048,"name":"writeTextMessage","url":"classes/websocket.html#writetextmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1298,"kind":2048,"name":"closeHandler","url":"classes/websocket.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1299,"kind":2048,"name":"frameHandler","url":"classes/websocket.html#framehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1300,"kind":256,"name":"WebSocketBase","url":"interfaces/websocketbase.html","classes":"tsd-kind-interface"},{"id":1301,"kind":2048,"name":"end","url":"interfaces/websocketbase.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1302,"kind":2048,"name":"writeQueueFull","url":"interfaces/websocketbase.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1303,"kind":2048,"name":"exceptionHandler","url":"interfaces/websocketbase.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1304,"kind":2048,"name":"handler","url":"interfaces/websocketbase.html#handler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1305,"kind":2048,"name":"pause","url":"interfaces/websocketbase.html#pause","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1306,"kind":2048,"name":"resume","url":"interfaces/websocketbase.html#resume","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1307,"kind":2048,"name":"endHandler","url":"interfaces/websocketbase.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1308,"kind":2048,"name":"write","url":"interfaces/websocketbase.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1309,"kind":2048,"name":"setWriteQueueMaxSize","url":"interfaces/websocketbase.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1310,"kind":2048,"name":"drainHandler","url":"interfaces/websocketbase.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1311,"kind":2048,"name":"binaryHandlerID","url":"interfaces/websocketbase.html#binaryhandlerid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1312,"kind":2048,"name":"textHandlerID","url":"interfaces/websocketbase.html#texthandlerid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1313,"kind":2048,"name":"subProtocol","url":"interfaces/websocketbase.html#subprotocol","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1314,"kind":2048,"name":"writeFrame","url":"interfaces/websocketbase.html#writeframe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1315,"kind":2048,"name":"writeFinalTextFrame","url":"interfaces/websocketbase.html#writefinaltextframe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1316,"kind":2048,"name":"writeFinalBinaryFrame","url":"interfaces/websocketbase.html#writefinalbinaryframe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1317,"kind":2048,"name":"writeBinaryMessage","url":"interfaces/websocketbase.html#writebinarymessage","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1318,"kind":2048,"name":"writeTextMessage","url":"interfaces/websocketbase.html#writetextmessage","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1319,"kind":2048,"name":"writePing","url":"interfaces/websocketbase.html#writeping","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1320,"kind":2048,"name":"writePong","url":"interfaces/websocketbase.html#writepong","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1321,"kind":2048,"name":"closeHandler","url":"interfaces/websocketbase.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1322,"kind":2048,"name":"frameHandler","url":"interfaces/websocketbase.html#framehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1323,"kind":2048,"name":"textMessageHandler","url":"interfaces/websocketbase.html#textmessagehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1324,"kind":2048,"name":"binaryMessageHandler","url":"interfaces/websocketbase.html#binarymessagehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1325,"kind":2048,"name":"pongHandler","url":"interfaces/websocketbase.html#ponghandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1326,"kind":2048,"name":"close","url":"interfaces/websocketbase.html#close","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1327,"kind":2048,"name":"remoteAddress","url":"interfaces/websocketbase.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1328,"kind":2048,"name":"localAddress","url":"interfaces/websocketbase.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1329,"kind":2048,"name":"isSsl","url":"interfaces/websocketbase.html#isssl","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1330,"kind":128,"name":"WebSocketFrame","url":"classes/websocketframe.html","classes":"tsd-kind-class"},{"id":1331,"kind":2048,"name":"binaryFrame","url":"classes/websocketframe.html#binaryframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1332,"kind":2048,"name":"textFrame","url":"classes/websocketframe.html#textframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1333,"kind":2048,"name":"pingFrame","url":"classes/websocketframe.html#pingframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1334,"kind":2048,"name":"pongFrame","url":"classes/websocketframe.html#pongframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1335,"kind":2048,"name":"continuationFrame","url":"classes/websocketframe.html#continuationframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1336,"kind":2048,"name":"isText","url":"classes/websocketframe.html#istext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1337,"kind":2048,"name":"isBinary","url":"classes/websocketframe.html#isbinary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1338,"kind":2048,"name":"isContinuation","url":"classes/websocketframe.html#iscontinuation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1339,"kind":2048,"name":"isClose","url":"classes/websocketframe.html#isclose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1340,"kind":2048,"name":"textData","url":"classes/websocketframe.html#textdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1341,"kind":2048,"name":"binaryData","url":"classes/websocketframe.html#binarydata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1342,"kind":2048,"name":"isFinal","url":"classes/websocketframe.html#isfinal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1343,"kind":2048,"name":"closeStatusCode","url":"classes/websocketframe.html#closestatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1344,"kind":2048,"name":"closeReason","url":"classes/websocketframe.html#closereason","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1345,"kind":128,"name":"WorkerExecutor","url":"classes/workerexecutor.html","classes":"tsd-kind-class"},{"id":1346,"kind":2048,"name":"isMetricsEnabled","url":"classes/workerexecutor.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WorkerExecutor"},{"id":1347,"kind":2048,"name":"executeBlocking","url":"classes/workerexecutor.html#executeblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WorkerExecutor"},{"id":1348,"kind":2048,"name":"close","url":"classes/workerexecutor.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WorkerExecutor"},{"id":1349,"kind":256,"name":"WriteStream","url":"interfaces/writestream.html","classes":"tsd-kind-interface"},{"id":1350,"kind":2048,"name":"exceptionHandler","url":"interfaces/writestream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1351,"kind":2048,"name":"write","url":"interfaces/writestream.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1352,"kind":2048,"name":"end","url":"interfaces/writestream.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1353,"kind":2048,"name":"setWriteQueueMaxSize","url":"interfaces/writestream.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1354,"kind":2048,"name":"writeQueueFull","url":"interfaces/writestream.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1355,"kind":2048,"name":"drainHandler","url":"interfaces/writestream.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1356,"kind":64,"name":"setTimeout","url":"globals.html#settimeout","classes":"tsd-kind-function tsd-is-not-exported"},{"id":1357,"kind":64,"name":"clearTimeout","url":"globals.html#cleartimeout","classes":"tsd-kind-function tsd-is-not-exported"},{"id":1358,"kind":64,"name":"setInterval","url":"globals.html#setinterval","classes":"tsd-kind-function tsd-is-not-exported"},{"id":1359,"kind":64,"name":"clearInterval","url":"globals.html#clearinterval","classes":"tsd-kind-function tsd-is-not-exported"},{"id":1360,"kind":64,"name":"setImmediate","url":"globals.html#setimmediate","classes":"tsd-kind-function tsd-is-not-exported"},{"id":1361,"kind":32,"name":"require","url":"globals.html#require","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":1362,"kind":65536,"name":"__type","url":"globals.html#require.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"require"},{"id":1363,"kind":64,"name":"resolve","url":"globals.html#require.__type.resolve","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"require.__type"},{"id":1364,"kind":32,"name":"cache","url":"globals.html#require.__type.cache","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"require.__type"},{"id":1365,"kind":32,"name":"extensions","url":"globals.html#require.__type.extensions","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"require.__type"},{"id":1366,"kind":32,"name":"Java","url":"globals.html#java","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":1367,"kind":65536,"name":"__type","url":"globals.html#java.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Java"},{"id":1368,"kind":64,"name":"type","url":"globals.html#java.__type.type","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Java.__type"},{"id":1369,"kind":64,"name":"from","url":"globals.html#java.__type.from","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Java.__type"},{"id":1370,"kind":64,"name":"to","url":"globals.html#java.__type.to","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Java.__type"},{"id":1371,"kind":64,"name":"isJavaObject","url":"globals.html#java.__type.isjavaobject","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Java.__type"},{"id":1372,"kind":64,"name":"isType","url":"globals.html#java.__type.istype","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Java.__type"},{"id":1373,"kind":64,"name":"typeName","url":"globals.html#java.__type.typename","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Java.__type"},{"id":1374,"kind":32,"name":"process","url":"globals.html#process","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":1375,"kind":65536,"name":"__type","url":"globals.html#process.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"process"},{"id":1376,"kind":32,"name":"env","url":"globals.html#process.__type.env","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1377,"kind":65536,"name":"__type","url":"globals.html#process.__type.env.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"process.__type.env"},{"id":1378,"kind":32,"name":"pid","url":"globals.html#process.__type.pid","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1379,"kind":32,"name":"engine","url":"globals.html#process.__type.engine","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1380,"kind":32,"name":"exit","url":"globals.html#process.__type.exit","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1381,"kind":65536,"name":"__type","url":"globals.html#process.__type.exit.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"process.__type.exit"},{"id":1382,"kind":32,"name":"nextTick","url":"globals.html#process.__type.nexttick","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1383,"kind":65536,"name":"__type","url":"globals.html#process.__type.nexttick.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"process.__type.nextTick"},{"id":1384,"kind":32,"name":"stdout","url":"globals.html#process.__type.stdout","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1385,"kind":32,"name":"stderr","url":"globals.html#process.__type.stderr","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1386,"kind":32,"name":"stdin","url":"globals.html#process.__type.stdin","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"process.__type"},{"id":1387,"kind":2,"name":"__global","url":"modules/__global.html","classes":"tsd-kind-module tsd-is-not-exported"},{"id":1388,"kind":32,"name":"vertx","url":"modules/__global.html#vertx","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"__global"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"2":"Module","4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":4,"name":"ClientAuth","url":"enums/clientauth.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"NONE","url":"enums/clientauth.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ClientAuth"},{"id":2,"kind":16,"name":"REQUEST","url":"enums/clientauth.html#request","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ClientAuth"},{"id":3,"kind":16,"name":"REQUIRED","url":"enums/clientauth.html#required","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ClientAuth"},{"id":4,"kind":4,"name":"DnsResponseCode","url":"enums/dnsresponsecode.html","classes":"tsd-kind-enum"},{"id":5,"kind":16,"name":"NOERROR","url":"enums/dnsresponsecode.html#noerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":6,"kind":16,"name":"FORMERROR","url":"enums/dnsresponsecode.html#formerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":7,"kind":16,"name":"SERVFAIL","url":"enums/dnsresponsecode.html#servfail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":8,"kind":16,"name":"NXDOMAIN","url":"enums/dnsresponsecode.html#nxdomain","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":9,"kind":16,"name":"NOTIMPL","url":"enums/dnsresponsecode.html#notimpl","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":10,"kind":16,"name":"REFUSED","url":"enums/dnsresponsecode.html#refused","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":11,"kind":16,"name":"YXDOMAIN","url":"enums/dnsresponsecode.html#yxdomain","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":12,"kind":16,"name":"YXRRSET","url":"enums/dnsresponsecode.html#yxrrset","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":13,"kind":16,"name":"NXRRSET","url":"enums/dnsresponsecode.html#nxrrset","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":14,"kind":16,"name":"NOTAUTH","url":"enums/dnsresponsecode.html#notauth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":15,"kind":16,"name":"NOTZONE","url":"enums/dnsresponsecode.html#notzone","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":16,"kind":16,"name":"BADVERS","url":"enums/dnsresponsecode.html#badvers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":17,"kind":16,"name":"BADSIG","url":"enums/dnsresponsecode.html#badsig","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":18,"kind":16,"name":"BADKEY","url":"enums/dnsresponsecode.html#badkey","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":19,"kind":16,"name":"BADTIME","url":"enums/dnsresponsecode.html#badtime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"DnsResponseCode"},{"id":20,"kind":4,"name":"HttpMethod","url":"enums/httpmethod.html","classes":"tsd-kind-enum"},{"id":21,"kind":16,"name":"OPTIONS","url":"enums/httpmethod.html#options","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":22,"kind":16,"name":"GET","url":"enums/httpmethod.html#get","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":23,"kind":16,"name":"HEAD","url":"enums/httpmethod.html#head","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":24,"kind":16,"name":"POST","url":"enums/httpmethod.html#post","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":25,"kind":16,"name":"PUT","url":"enums/httpmethod.html#put","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":26,"kind":16,"name":"DELETE","url":"enums/httpmethod.html#delete","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":27,"kind":16,"name":"TRACE","url":"enums/httpmethod.html#trace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":28,"kind":16,"name":"CONNECT","url":"enums/httpmethod.html#connect","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":29,"kind":16,"name":"PATCH","url":"enums/httpmethod.html#patch","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":30,"kind":16,"name":"OTHER","url":"enums/httpmethod.html#other","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpMethod"},{"id":31,"kind":4,"name":"HttpVersion","url":"enums/httpversion.html","classes":"tsd-kind-enum"},{"id":32,"kind":16,"name":"HTTP_1_0","url":"enums/httpversion.html#http_1_0","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpVersion"},{"id":33,"kind":16,"name":"HTTP_1_1","url":"enums/httpversion.html#http_1_1","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpVersion"},{"id":34,"kind":16,"name":"HTTP_2","url":"enums/httpversion.html#http_2","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"HttpVersion"},{"id":35,"kind":4,"name":"JsonEventType","url":"enums/jsoneventtype.html","classes":"tsd-kind-enum"},{"id":36,"kind":16,"name":"START_OBJECT","url":"enums/jsoneventtype.html#start_object","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":37,"kind":16,"name":"END_OBJECT","url":"enums/jsoneventtype.html#end_object","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":38,"kind":16,"name":"START_ARRAY","url":"enums/jsoneventtype.html#start_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":39,"kind":16,"name":"END_ARRAY","url":"enums/jsoneventtype.html#end_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":40,"kind":16,"name":"VALUE","url":"enums/jsoneventtype.html#value","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"JsonEventType"},{"id":41,"kind":4,"name":"ProxyType","url":"enums/proxytype.html","classes":"tsd-kind-enum"},{"id":42,"kind":16,"name":"HTTP","url":"enums/proxytype.html#http","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ProxyType"},{"id":43,"kind":16,"name":"SOCKS4","url":"enums/proxytype.html#socks4","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ProxyType"},{"id":44,"kind":16,"name":"SOCKS5","url":"enums/proxytype.html#socks5","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ProxyType"},{"id":45,"kind":4,"name":"ReplyFailure","url":"enums/replyfailure.html","classes":"tsd-kind-enum"},{"id":46,"kind":16,"name":"TIMEOUT","url":"enums/replyfailure.html#timeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ReplyFailure"},{"id":47,"kind":16,"name":"NO_HANDLERS","url":"enums/replyfailure.html#no_handlers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ReplyFailure"},{"id":48,"kind":16,"name":"RECIPIENT_FAILURE","url":"enums/replyfailure.html#recipient_failure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ReplyFailure"},{"id":49,"kind":4,"name":"WebsocketVersion","url":"enums/websocketversion.html","classes":"tsd-kind-enum"},{"id":50,"kind":16,"name":"V00","url":"enums/websocketversion.html#v00","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":51,"kind":16,"name":"V07","url":"enums/websocketversion.html#v07","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":52,"kind":16,"name":"V08","url":"enums/websocketversion.html#v08","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":53,"kind":16,"name":"V13","url":"enums/websocketversion.html#v13","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"WebsocketVersion"},{"id":54,"kind":128,"name":"AddressResolverOptions","url":"classes/addressresolveroptions.html","classes":"tsd-kind-class"},{"id":55,"kind":512,"name":"constructor","url":"classes/addressresolveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":56,"kind":2048,"name":"getCacheMaxTimeToLive","url":"classes/addressresolveroptions.html#getcachemaxtimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":57,"kind":2048,"name":"setCacheMaxTimeToLive","url":"classes/addressresolveroptions.html#setcachemaxtimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":58,"kind":2048,"name":"getCacheMinTimeToLive","url":"classes/addressresolveroptions.html#getcachemintimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":59,"kind":2048,"name":"setCacheMinTimeToLive","url":"classes/addressresolveroptions.html#setcachemintimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":60,"kind":2048,"name":"getCacheNegativeTimeToLive","url":"classes/addressresolveroptions.html#getcachenegativetimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":61,"kind":2048,"name":"setCacheNegativeTimeToLive","url":"classes/addressresolveroptions.html#setcachenegativetimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":62,"kind":2048,"name":"getHostsPath","url":"classes/addressresolveroptions.html#gethostspath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":63,"kind":2048,"name":"setHostsPath","url":"classes/addressresolveroptions.html#sethostspath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":64,"kind":2048,"name":"getHostsValue","url":"classes/addressresolveroptions.html#gethostsvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":65,"kind":2048,"name":"setHostsValue","url":"classes/addressresolveroptions.html#sethostsvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":66,"kind":2048,"name":"getMaxQueries","url":"classes/addressresolveroptions.html#getmaxqueries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":67,"kind":2048,"name":"setMaxQueries","url":"classes/addressresolveroptions.html#setmaxqueries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":68,"kind":2048,"name":"getNdots","url":"classes/addressresolveroptions.html#getndots","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":69,"kind":2048,"name":"setNdots","url":"classes/addressresolveroptions.html#setndots","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":70,"kind":2048,"name":"isOptResourceEnabled","url":"classes/addressresolveroptions.html#isoptresourceenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":71,"kind":2048,"name":"setOptResourceEnabled","url":"classes/addressresolveroptions.html#setoptresourceenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":72,"kind":2048,"name":"getQueryTimeout","url":"classes/addressresolveroptions.html#getquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":73,"kind":2048,"name":"setQueryTimeout","url":"classes/addressresolveroptions.html#setquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":74,"kind":2048,"name":"getRdFlag","url":"classes/addressresolveroptions.html#getrdflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":75,"kind":2048,"name":"setRdFlag","url":"classes/addressresolveroptions.html#setrdflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":76,"kind":2048,"name":"isRotateServers","url":"classes/addressresolveroptions.html#isrotateservers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":77,"kind":2048,"name":"setRotateServers","url":"classes/addressresolveroptions.html#setrotateservers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":78,"kind":2048,"name":"getSearchDomains","url":"classes/addressresolveroptions.html#getsearchdomains","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":79,"kind":2048,"name":"setSearchDomains","url":"classes/addressresolveroptions.html#setsearchdomains","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":80,"kind":2048,"name":"addSearchDomain","url":"classes/addressresolveroptions.html#addsearchdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":81,"kind":2048,"name":"getServers","url":"classes/addressresolveroptions.html#getservers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":82,"kind":2048,"name":"setServers","url":"classes/addressresolveroptions.html#setservers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":83,"kind":2048,"name":"addServer","url":"classes/addressresolveroptions.html#addserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AddressResolverOptions"},{"id":84,"kind":128,"name":"Argument","url":"classes/argument.html","classes":"tsd-kind-class"},{"id":85,"kind":512,"name":"constructor","url":"classes/argument.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Argument"},{"id":86,"kind":2048,"name":"getArgName","url":"classes/argument.html#getargname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":87,"kind":2048,"name":"setArgName","url":"classes/argument.html#setargname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":88,"kind":2048,"name":"getDefaultValue","url":"classes/argument.html#getdefaultvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":89,"kind":2048,"name":"setDefaultValue","url":"classes/argument.html#setdefaultvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":90,"kind":2048,"name":"getDescription","url":"classes/argument.html#getdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":91,"kind":2048,"name":"setDescription","url":"classes/argument.html#setdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":92,"kind":2048,"name":"isHidden","url":"classes/argument.html#ishidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":93,"kind":2048,"name":"setHidden","url":"classes/argument.html#sethidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":94,"kind":2048,"name":"getIndex","url":"classes/argument.html#getindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":95,"kind":2048,"name":"setIndex","url":"classes/argument.html#setindex","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":96,"kind":2048,"name":"isMultiValued","url":"classes/argument.html#ismultivalued","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":97,"kind":2048,"name":"setMultiValued","url":"classes/argument.html#setmultivalued","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":98,"kind":2048,"name":"isRequired","url":"classes/argument.html#isrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":99,"kind":2048,"name":"setRequired","url":"classes/argument.html#setrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Argument"},{"id":100,"kind":128,"name":"ClientOptionsBase","url":"classes/clientoptionsbase.html","classes":"tsd-kind-class"},{"id":101,"kind":512,"name":"constructor","url":"classes/clientoptionsbase.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":102,"kind":2048,"name":"getConnectTimeout","url":"classes/clientoptionsbase.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":103,"kind":2048,"name":"setConnectTimeout","url":"classes/clientoptionsbase.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":104,"kind":2048,"name":"getCrlPaths","url":"classes/clientoptionsbase.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":105,"kind":2048,"name":"addCrlPath","url":"classes/clientoptionsbase.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":106,"kind":2048,"name":"getCrlValues","url":"classes/clientoptionsbase.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":107,"kind":2048,"name":"addCrlValue","url":"classes/clientoptionsbase.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":108,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/clientoptionsbase.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":109,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/clientoptionsbase.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":110,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/clientoptionsbase.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":111,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/clientoptionsbase.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":112,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/clientoptionsbase.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":113,"kind":2048,"name":"getIdleTimeout","url":"classes/clientoptionsbase.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":114,"kind":2048,"name":"setIdleTimeout","url":"classes/clientoptionsbase.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":115,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/clientoptionsbase.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":116,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/clientoptionsbase.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":117,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/clientoptionsbase.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":118,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/clientoptionsbase.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":119,"kind":2048,"name":"getKeyStoreOptions","url":"classes/clientoptionsbase.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":120,"kind":2048,"name":"setKeyStoreOptions","url":"classes/clientoptionsbase.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":121,"kind":2048,"name":"getLocalAddress","url":"classes/clientoptionsbase.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":122,"kind":2048,"name":"setLocalAddress","url":"classes/clientoptionsbase.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":123,"kind":2048,"name":"getLogActivity","url":"classes/clientoptionsbase.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":124,"kind":2048,"name":"setLogActivity","url":"classes/clientoptionsbase.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":125,"kind":2048,"name":"getMetricsName","url":"classes/clientoptionsbase.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":126,"kind":2048,"name":"setMetricsName","url":"classes/clientoptionsbase.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":127,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/clientoptionsbase.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":128,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/clientoptionsbase.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":129,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/clientoptionsbase.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":130,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/clientoptionsbase.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":131,"kind":2048,"name":"getPemTrustOptions","url":"classes/clientoptionsbase.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":132,"kind":2048,"name":"setPemTrustOptions","url":"classes/clientoptionsbase.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":133,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/clientoptionsbase.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":134,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/clientoptionsbase.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":135,"kind":2048,"name":"getPfxTrustOptions","url":"classes/clientoptionsbase.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":136,"kind":2048,"name":"setPfxTrustOptions","url":"classes/clientoptionsbase.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":137,"kind":2048,"name":"getProxyOptions","url":"classes/clientoptionsbase.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":138,"kind":2048,"name":"setProxyOptions","url":"classes/clientoptionsbase.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":139,"kind":2048,"name":"getReceiveBufferSize","url":"classes/clientoptionsbase.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":140,"kind":2048,"name":"setReceiveBufferSize","url":"classes/clientoptionsbase.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":141,"kind":2048,"name":"isReuseAddress","url":"classes/clientoptionsbase.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":142,"kind":2048,"name":"setReuseAddress","url":"classes/clientoptionsbase.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":143,"kind":2048,"name":"isReusePort","url":"classes/clientoptionsbase.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":144,"kind":2048,"name":"setReusePort","url":"classes/clientoptionsbase.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":145,"kind":2048,"name":"getSendBufferSize","url":"classes/clientoptionsbase.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":146,"kind":2048,"name":"setSendBufferSize","url":"classes/clientoptionsbase.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":147,"kind":2048,"name":"getSoLinger","url":"classes/clientoptionsbase.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":148,"kind":2048,"name":"setSoLinger","url":"classes/clientoptionsbase.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":149,"kind":2048,"name":"isSsl","url":"classes/clientoptionsbase.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":150,"kind":2048,"name":"setSsl","url":"classes/clientoptionsbase.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":151,"kind":2048,"name":"isTcpCork","url":"classes/clientoptionsbase.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":152,"kind":2048,"name":"setTcpCork","url":"classes/clientoptionsbase.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":153,"kind":2048,"name":"isTcpFastOpen","url":"classes/clientoptionsbase.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":154,"kind":2048,"name":"setTcpFastOpen","url":"classes/clientoptionsbase.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":155,"kind":2048,"name":"isTcpKeepAlive","url":"classes/clientoptionsbase.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":156,"kind":2048,"name":"setTcpKeepAlive","url":"classes/clientoptionsbase.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":157,"kind":2048,"name":"isTcpNoDelay","url":"classes/clientoptionsbase.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":158,"kind":2048,"name":"setTcpNoDelay","url":"classes/clientoptionsbase.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":159,"kind":2048,"name":"isTcpQuickAck","url":"classes/clientoptionsbase.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":160,"kind":2048,"name":"setTcpQuickAck","url":"classes/clientoptionsbase.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":161,"kind":2048,"name":"getTrafficClass","url":"classes/clientoptionsbase.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":162,"kind":2048,"name":"setTrafficClass","url":"classes/clientoptionsbase.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":163,"kind":2048,"name":"isTrustAll","url":"classes/clientoptionsbase.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":164,"kind":2048,"name":"setTrustAll","url":"classes/clientoptionsbase.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":165,"kind":2048,"name":"getTrustStoreOptions","url":"classes/clientoptionsbase.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":166,"kind":2048,"name":"setTrustStoreOptions","url":"classes/clientoptionsbase.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":167,"kind":2048,"name":"isUseAlpn","url":"classes/clientoptionsbase.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":168,"kind":2048,"name":"setUseAlpn","url":"classes/clientoptionsbase.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":169,"kind":2048,"name":"isUsePooledBuffers","url":"classes/clientoptionsbase.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":170,"kind":2048,"name":"setUsePooledBuffers","url":"classes/clientoptionsbase.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ClientOptionsBase"},{"id":171,"kind":128,"name":"CopyOptions","url":"classes/copyoptions.html","classes":"tsd-kind-class"},{"id":172,"kind":512,"name":"constructor","url":"classes/copyoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"CopyOptions"},{"id":173,"kind":2048,"name":"isAtomicMove","url":"classes/copyoptions.html#isatomicmove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":174,"kind":2048,"name":"setAtomicMove","url":"classes/copyoptions.html#setatomicmove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":175,"kind":2048,"name":"isCopyAttributes","url":"classes/copyoptions.html#iscopyattributes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":176,"kind":2048,"name":"setCopyAttributes","url":"classes/copyoptions.html#setcopyattributes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":177,"kind":2048,"name":"isNofollowLinks","url":"classes/copyoptions.html#isnofollowlinks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":178,"kind":2048,"name":"setNofollowLinks","url":"classes/copyoptions.html#setnofollowlinks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":179,"kind":2048,"name":"isReplaceExisting","url":"classes/copyoptions.html#isreplaceexisting","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":180,"kind":2048,"name":"setReplaceExisting","url":"classes/copyoptions.html#setreplaceexisting","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CopyOptions"},{"id":181,"kind":128,"name":"DatagramSocketOptions","url":"classes/datagramsocketoptions.html","classes":"tsd-kind-class"},{"id":182,"kind":512,"name":"constructor","url":"classes/datagramsocketoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":183,"kind":2048,"name":"isBroadcast","url":"classes/datagramsocketoptions.html#isbroadcast","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":184,"kind":2048,"name":"setBroadcast","url":"classes/datagramsocketoptions.html#setbroadcast","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":185,"kind":2048,"name":"isIpV6","url":"classes/datagramsocketoptions.html#isipv6","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":186,"kind":2048,"name":"setIpV6","url":"classes/datagramsocketoptions.html#setipv6","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":187,"kind":2048,"name":"getLogActivity","url":"classes/datagramsocketoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":188,"kind":2048,"name":"setLogActivity","url":"classes/datagramsocketoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":189,"kind":2048,"name":"isLoopbackModeDisabled","url":"classes/datagramsocketoptions.html#isloopbackmodedisabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":190,"kind":2048,"name":"setLoopbackModeDisabled","url":"classes/datagramsocketoptions.html#setloopbackmodedisabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":191,"kind":2048,"name":"getMulticastNetworkInterface","url":"classes/datagramsocketoptions.html#getmulticastnetworkinterface","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":192,"kind":2048,"name":"setMulticastNetworkInterface","url":"classes/datagramsocketoptions.html#setmulticastnetworkinterface","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":193,"kind":2048,"name":"getMulticastTimeToLive","url":"classes/datagramsocketoptions.html#getmulticasttimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":194,"kind":2048,"name":"setMulticastTimeToLive","url":"classes/datagramsocketoptions.html#setmulticasttimetolive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":195,"kind":2048,"name":"getReceiveBufferSize","url":"classes/datagramsocketoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":196,"kind":2048,"name":"setReceiveBufferSize","url":"classes/datagramsocketoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":197,"kind":2048,"name":"isReuseAddress","url":"classes/datagramsocketoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":198,"kind":2048,"name":"setReuseAddress","url":"classes/datagramsocketoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":199,"kind":2048,"name":"isReusePort","url":"classes/datagramsocketoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":200,"kind":2048,"name":"setReusePort","url":"classes/datagramsocketoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":201,"kind":2048,"name":"getSendBufferSize","url":"classes/datagramsocketoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":202,"kind":2048,"name":"setSendBufferSize","url":"classes/datagramsocketoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":203,"kind":2048,"name":"getTrafficClass","url":"classes/datagramsocketoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":204,"kind":2048,"name":"setTrafficClass","url":"classes/datagramsocketoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocketOptions"},{"id":205,"kind":128,"name":"DeliveryOptions","url":"classes/deliveryoptions.html","classes":"tsd-kind-class"},{"id":206,"kind":512,"name":"constructor","url":"classes/deliveryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":207,"kind":2048,"name":"getCodecName","url":"classes/deliveryoptions.html#getcodecname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":208,"kind":2048,"name":"setCodecName","url":"classes/deliveryoptions.html#setcodecname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":209,"kind":2048,"name":"headers","url":"classes/deliveryoptions.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":210,"kind":2048,"name":"addHeader","url":"classes/deliveryoptions.html#addheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":211,"kind":2048,"name":"isLocalOnly","url":"classes/deliveryoptions.html#islocalonly","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":212,"kind":2048,"name":"setLocalOnly","url":"classes/deliveryoptions.html#setlocalonly","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":213,"kind":2048,"name":"getSendTimeout","url":"classes/deliveryoptions.html#getsendtimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":214,"kind":2048,"name":"setSendTimeout","url":"classes/deliveryoptions.html#setsendtimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryOptions"},{"id":215,"kind":128,"name":"DeploymentOptions","url":"classes/deploymentoptions.html","classes":"tsd-kind-class"},{"id":216,"kind":512,"name":"constructor","url":"classes/deploymentoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":217,"kind":2048,"name":"getConfig","url":"classes/deploymentoptions.html#getconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":218,"kind":2048,"name":"setConfig","url":"classes/deploymentoptions.html#setconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":219,"kind":2048,"name":"getExtraClasspath","url":"classes/deploymentoptions.html#getextraclasspath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":220,"kind":2048,"name":"setExtraClasspath","url":"classes/deploymentoptions.html#setextraclasspath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":221,"kind":2048,"name":"isHa","url":"classes/deploymentoptions.html#isha","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":222,"kind":2048,"name":"setHa","url":"classes/deploymentoptions.html#setha","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":223,"kind":2048,"name":"getInstances","url":"classes/deploymentoptions.html#getinstances","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":224,"kind":2048,"name":"setInstances","url":"classes/deploymentoptions.html#setinstances","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":225,"kind":2048,"name":"getIsolatedClasses","url":"classes/deploymentoptions.html#getisolatedclasses","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":226,"kind":2048,"name":"setIsolatedClasses","url":"classes/deploymentoptions.html#setisolatedclasses","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":227,"kind":2048,"name":"getIsolationGroup","url":"classes/deploymentoptions.html#getisolationgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":228,"kind":2048,"name":"setIsolationGroup","url":"classes/deploymentoptions.html#setisolationgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":229,"kind":2048,"name":"getMaxWorkerExecuteTime","url":"classes/deploymentoptions.html#getmaxworkerexecutetime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":230,"kind":2048,"name":"setMaxWorkerExecuteTime","url":"classes/deploymentoptions.html#setmaxworkerexecutetime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":231,"kind":2048,"name":"getMaxWorkerExecuteTimeUnit","url":"classes/deploymentoptions.html#getmaxworkerexecutetimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":232,"kind":2048,"name":"setMaxWorkerExecuteTimeUnit","url":"classes/deploymentoptions.html#setmaxworkerexecutetimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":233,"kind":2048,"name":"isMultiThreaded","url":"classes/deploymentoptions.html#ismultithreaded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":234,"kind":2048,"name":"setMultiThreaded","url":"classes/deploymentoptions.html#setmultithreaded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":235,"kind":2048,"name":"isWorker","url":"classes/deploymentoptions.html#isworker","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":236,"kind":2048,"name":"setWorker","url":"classes/deploymentoptions.html#setworker","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":237,"kind":2048,"name":"getWorkerPoolName","url":"classes/deploymentoptions.html#getworkerpoolname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":238,"kind":2048,"name":"setWorkerPoolName","url":"classes/deploymentoptions.html#setworkerpoolname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":239,"kind":2048,"name":"getWorkerPoolSize","url":"classes/deploymentoptions.html#getworkerpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":240,"kind":2048,"name":"setWorkerPoolSize","url":"classes/deploymentoptions.html#setworkerpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeploymentOptions"},{"id":241,"kind":128,"name":"DnsClientOptions","url":"classes/dnsclientoptions.html","classes":"tsd-kind-class"},{"id":242,"kind":512,"name":"constructor","url":"classes/dnsclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":243,"kind":2048,"name":"getHost","url":"classes/dnsclientoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":244,"kind":2048,"name":"setHost","url":"classes/dnsclientoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":245,"kind":2048,"name":"getLogActivity","url":"classes/dnsclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":246,"kind":2048,"name":"setLogActivity","url":"classes/dnsclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":247,"kind":2048,"name":"getPort","url":"classes/dnsclientoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":248,"kind":2048,"name":"setPort","url":"classes/dnsclientoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":249,"kind":2048,"name":"getQueryTimeout","url":"classes/dnsclientoptions.html#getquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":250,"kind":2048,"name":"setQueryTimeout","url":"classes/dnsclientoptions.html#setquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":251,"kind":2048,"name":"isRecursionDesired","url":"classes/dnsclientoptions.html#isrecursiondesired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":252,"kind":2048,"name":"setRecursionDesired","url":"classes/dnsclientoptions.html#setrecursiondesired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClientOptions"},{"id":253,"kind":128,"name":"EventBusOptions","url":"classes/eventbusoptions.html","classes":"tsd-kind-class"},{"id":254,"kind":512,"name":"constructor","url":"classes/eventbusoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"EventBusOptions"},{"id":255,"kind":2048,"name":"getAcceptBacklog","url":"classes/eventbusoptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":256,"kind":2048,"name":"setAcceptBacklog","url":"classes/eventbusoptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":257,"kind":2048,"name":"getClientAuth","url":"classes/eventbusoptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":258,"kind":2048,"name":"setClientAuth","url":"classes/eventbusoptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":259,"kind":2048,"name":"getClusterPingInterval","url":"classes/eventbusoptions.html#getclusterpinginterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":260,"kind":2048,"name":"setClusterPingInterval","url":"classes/eventbusoptions.html#setclusterpinginterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":261,"kind":2048,"name":"getClusterPingReplyInterval","url":"classes/eventbusoptions.html#getclusterpingreplyinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":262,"kind":2048,"name":"setClusterPingReplyInterval","url":"classes/eventbusoptions.html#setclusterpingreplyinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":263,"kind":2048,"name":"getClusterPublicHost","url":"classes/eventbusoptions.html#getclusterpublichost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":264,"kind":2048,"name":"setClusterPublicHost","url":"classes/eventbusoptions.html#setclusterpublichost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":265,"kind":2048,"name":"getClusterPublicPort","url":"classes/eventbusoptions.html#getclusterpublicport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":266,"kind":2048,"name":"setClusterPublicPort","url":"classes/eventbusoptions.html#setclusterpublicport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":267,"kind":2048,"name":"isClustered","url":"classes/eventbusoptions.html#isclustered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":268,"kind":2048,"name":"setClustered","url":"classes/eventbusoptions.html#setclustered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":269,"kind":2048,"name":"getConnectTimeout","url":"classes/eventbusoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":270,"kind":2048,"name":"setConnectTimeout","url":"classes/eventbusoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":271,"kind":2048,"name":"getCrlPaths","url":"classes/eventbusoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":272,"kind":2048,"name":"addCrlPath","url":"classes/eventbusoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":273,"kind":2048,"name":"getCrlValues","url":"classes/eventbusoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":274,"kind":2048,"name":"addCrlValue","url":"classes/eventbusoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":275,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/eventbusoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":276,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/eventbusoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":277,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/eventbusoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":278,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/eventbusoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":279,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/eventbusoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":280,"kind":2048,"name":"getHost","url":"classes/eventbusoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":281,"kind":2048,"name":"setHost","url":"classes/eventbusoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":282,"kind":2048,"name":"getIdleTimeout","url":"classes/eventbusoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":283,"kind":2048,"name":"setIdleTimeout","url":"classes/eventbusoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":284,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/eventbusoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":285,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/eventbusoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":286,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/eventbusoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":287,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/eventbusoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":288,"kind":2048,"name":"getKeyStoreOptions","url":"classes/eventbusoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":289,"kind":2048,"name":"setKeyStoreOptions","url":"classes/eventbusoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":290,"kind":2048,"name":"getLogActivity","url":"classes/eventbusoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":291,"kind":2048,"name":"setLogActivity","url":"classes/eventbusoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":292,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/eventbusoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":293,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/eventbusoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":294,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/eventbusoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":295,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/eventbusoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":296,"kind":2048,"name":"getPemTrustOptions","url":"classes/eventbusoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":297,"kind":2048,"name":"setPemTrustOptions","url":"classes/eventbusoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":298,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/eventbusoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":299,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/eventbusoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":300,"kind":2048,"name":"getPfxTrustOptions","url":"classes/eventbusoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":301,"kind":2048,"name":"setPfxTrustOptions","url":"classes/eventbusoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":302,"kind":2048,"name":"getPort","url":"classes/eventbusoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":303,"kind":2048,"name":"setPort","url":"classes/eventbusoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":304,"kind":2048,"name":"getReceiveBufferSize","url":"classes/eventbusoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":305,"kind":2048,"name":"setReceiveBufferSize","url":"classes/eventbusoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":306,"kind":2048,"name":"getReconnectAttempts","url":"classes/eventbusoptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":307,"kind":2048,"name":"setReconnectAttempts","url":"classes/eventbusoptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":308,"kind":2048,"name":"getReconnectInterval","url":"classes/eventbusoptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":309,"kind":2048,"name":"setReconnectInterval","url":"classes/eventbusoptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":310,"kind":2048,"name":"isReuseAddress","url":"classes/eventbusoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":311,"kind":2048,"name":"setReuseAddress","url":"classes/eventbusoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":312,"kind":2048,"name":"isReusePort","url":"classes/eventbusoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":313,"kind":2048,"name":"setReusePort","url":"classes/eventbusoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":314,"kind":2048,"name":"getSendBufferSize","url":"classes/eventbusoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":315,"kind":2048,"name":"setSendBufferSize","url":"classes/eventbusoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":316,"kind":2048,"name":"getSoLinger","url":"classes/eventbusoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":317,"kind":2048,"name":"setSoLinger","url":"classes/eventbusoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":318,"kind":2048,"name":"isSsl","url":"classes/eventbusoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":319,"kind":2048,"name":"setSsl","url":"classes/eventbusoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":320,"kind":2048,"name":"isTcpCork","url":"classes/eventbusoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":321,"kind":2048,"name":"setTcpCork","url":"classes/eventbusoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":322,"kind":2048,"name":"isTcpFastOpen","url":"classes/eventbusoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":323,"kind":2048,"name":"setTcpFastOpen","url":"classes/eventbusoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":324,"kind":2048,"name":"isTcpKeepAlive","url":"classes/eventbusoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":325,"kind":2048,"name":"setTcpKeepAlive","url":"classes/eventbusoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":326,"kind":2048,"name":"isTcpNoDelay","url":"classes/eventbusoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":327,"kind":2048,"name":"setTcpNoDelay","url":"classes/eventbusoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":328,"kind":2048,"name":"isTcpQuickAck","url":"classes/eventbusoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":329,"kind":2048,"name":"setTcpQuickAck","url":"classes/eventbusoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":330,"kind":2048,"name":"getTrafficClass","url":"classes/eventbusoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":331,"kind":2048,"name":"setTrafficClass","url":"classes/eventbusoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":332,"kind":2048,"name":"isTrustAll","url":"classes/eventbusoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":333,"kind":2048,"name":"setTrustAll","url":"classes/eventbusoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":334,"kind":2048,"name":"getTrustStoreOptions","url":"classes/eventbusoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":335,"kind":2048,"name":"setTrustStoreOptions","url":"classes/eventbusoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":336,"kind":2048,"name":"isUseAlpn","url":"classes/eventbusoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":337,"kind":2048,"name":"setUseAlpn","url":"classes/eventbusoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":338,"kind":2048,"name":"isUsePooledBuffers","url":"classes/eventbusoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":339,"kind":2048,"name":"setUsePooledBuffers","url":"classes/eventbusoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusOptions"},{"id":340,"kind":128,"name":"FileSystemOptions","url":"classes/filesystemoptions.html","classes":"tsd-kind-class"},{"id":341,"kind":512,"name":"constructor","url":"classes/filesystemoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"FileSystemOptions"},{"id":342,"kind":2048,"name":"isClassPathResolvingEnabled","url":"classes/filesystemoptions.html#isclasspathresolvingenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemOptions"},{"id":343,"kind":2048,"name":"setClassPathResolvingEnabled","url":"classes/filesystemoptions.html#setclasspathresolvingenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemOptions"},{"id":344,"kind":2048,"name":"isFileCachingEnabled","url":"classes/filesystemoptions.html#isfilecachingenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemOptions"},{"id":345,"kind":2048,"name":"setFileCachingEnabled","url":"classes/filesystemoptions.html#setfilecachingenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemOptions"},{"id":346,"kind":128,"name":"GoAway","url":"classes/goaway.html","classes":"tsd-kind-class"},{"id":347,"kind":512,"name":"constructor","url":"classes/goaway.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"GoAway"},{"id":348,"kind":2048,"name":"getDebugData","url":"classes/goaway.html#getdebugdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GoAway"},{"id":349,"kind":2048,"name":"setDebugData","url":"classes/goaway.html#setdebugdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GoAway"},{"id":350,"kind":2048,"name":"getErrorCode","url":"classes/goaway.html#geterrorcode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GoAway"},{"id":351,"kind":2048,"name":"setErrorCode","url":"classes/goaway.html#seterrorcode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GoAway"},{"id":352,"kind":2048,"name":"getLastStreamId","url":"classes/goaway.html#getlaststreamid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GoAway"},{"id":353,"kind":2048,"name":"setLastStreamId","url":"classes/goaway.html#setlaststreamid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"GoAway"},{"id":354,"kind":128,"name":"Http2Settings","url":"classes/http2settings.html","classes":"tsd-kind-class"},{"id":355,"kind":512,"name":"constructor","url":"classes/http2settings.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Http2Settings"},{"id":356,"kind":2048,"name":"getHeaderTableSize","url":"classes/http2settings.html#getheadertablesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":357,"kind":2048,"name":"setHeaderTableSize","url":"classes/http2settings.html#setheadertablesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":358,"kind":2048,"name":"getInitialWindowSize","url":"classes/http2settings.html#getinitialwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":359,"kind":2048,"name":"setInitialWindowSize","url":"classes/http2settings.html#setinitialwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":360,"kind":2048,"name":"getMaxConcurrentStreams","url":"classes/http2settings.html#getmaxconcurrentstreams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":361,"kind":2048,"name":"setMaxConcurrentStreams","url":"classes/http2settings.html#setmaxconcurrentstreams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":362,"kind":2048,"name":"getMaxFrameSize","url":"classes/http2settings.html#getmaxframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":363,"kind":2048,"name":"setMaxFrameSize","url":"classes/http2settings.html#setmaxframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":364,"kind":2048,"name":"getMaxHeaderListSize","url":"classes/http2settings.html#getmaxheaderlistsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":365,"kind":2048,"name":"setMaxHeaderListSize","url":"classes/http2settings.html#setmaxheaderlistsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":366,"kind":2048,"name":"isPushEnabled","url":"classes/http2settings.html#ispushenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":367,"kind":2048,"name":"setPushEnabled","url":"classes/http2settings.html#setpushenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Http2Settings"},{"id":368,"kind":128,"name":"HttpClientOptions","url":"classes/httpclientoptions.html","classes":"tsd-kind-class"},{"id":369,"kind":512,"name":"constructor","url":"classes/httpclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":370,"kind":2048,"name":"getAlpnVersions","url":"classes/httpclientoptions.html#getalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":371,"kind":2048,"name":"setAlpnVersions","url":"classes/httpclientoptions.html#setalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":372,"kind":2048,"name":"getConnectTimeout","url":"classes/httpclientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":373,"kind":2048,"name":"setConnectTimeout","url":"classes/httpclientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":374,"kind":2048,"name":"getCrlPaths","url":"classes/httpclientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":375,"kind":2048,"name":"addCrlPath","url":"classes/httpclientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":376,"kind":2048,"name":"getCrlValues","url":"classes/httpclientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":377,"kind":2048,"name":"addCrlValue","url":"classes/httpclientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":378,"kind":2048,"name":"getDecoderInitialBufferSize","url":"classes/httpclientoptions.html#getdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":379,"kind":2048,"name":"setDecoderInitialBufferSize","url":"classes/httpclientoptions.html#setdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":380,"kind":2048,"name":"getDefaultHost","url":"classes/httpclientoptions.html#getdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":381,"kind":2048,"name":"setDefaultHost","url":"classes/httpclientoptions.html#setdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":382,"kind":2048,"name":"getDefaultPort","url":"classes/httpclientoptions.html#getdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":383,"kind":2048,"name":"setDefaultPort","url":"classes/httpclientoptions.html#setdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":384,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/httpclientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":385,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/httpclientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":386,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/httpclientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":387,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/httpclientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":388,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/httpclientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":389,"kind":2048,"name":"isForceSni","url":"classes/httpclientoptions.html#isforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":390,"kind":2048,"name":"setForceSni","url":"classes/httpclientoptions.html#setforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":391,"kind":2048,"name":"isHttp2ClearTextUpgrade","url":"classes/httpclientoptions.html#ishttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":392,"kind":2048,"name":"setHttp2ClearTextUpgrade","url":"classes/httpclientoptions.html#sethttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":393,"kind":2048,"name":"getHttp2ConnectionWindowSize","url":"classes/httpclientoptions.html#gethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":394,"kind":2048,"name":"setHttp2ConnectionWindowSize","url":"classes/httpclientoptions.html#sethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":395,"kind":2048,"name":"getHttp2KeepAliveTimeout","url":"classes/httpclientoptions.html#gethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":396,"kind":2048,"name":"setHttp2KeepAliveTimeout","url":"classes/httpclientoptions.html#sethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":397,"kind":2048,"name":"getHttp2MaxPoolSize","url":"classes/httpclientoptions.html#gethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":398,"kind":2048,"name":"setHttp2MaxPoolSize","url":"classes/httpclientoptions.html#sethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":399,"kind":2048,"name":"getHttp2MultiplexingLimit","url":"classes/httpclientoptions.html#gethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":400,"kind":2048,"name":"setHttp2MultiplexingLimit","url":"classes/httpclientoptions.html#sethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":401,"kind":2048,"name":"getIdleTimeout","url":"classes/httpclientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":402,"kind":2048,"name":"setIdleTimeout","url":"classes/httpclientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":403,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/httpclientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":404,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/httpclientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":405,"kind":2048,"name":"getInitialSettings","url":"classes/httpclientoptions.html#getinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":406,"kind":2048,"name":"setInitialSettings","url":"classes/httpclientoptions.html#setinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":407,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/httpclientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":408,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/httpclientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":409,"kind":2048,"name":"isKeepAlive","url":"classes/httpclientoptions.html#iskeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":410,"kind":2048,"name":"setKeepAlive","url":"classes/httpclientoptions.html#setkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":411,"kind":2048,"name":"getKeepAliveTimeout","url":"classes/httpclientoptions.html#getkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":412,"kind":2048,"name":"setKeepAliveTimeout","url":"classes/httpclientoptions.html#setkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":413,"kind":2048,"name":"getKeyStoreOptions","url":"classes/httpclientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":414,"kind":2048,"name":"setKeyStoreOptions","url":"classes/httpclientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":415,"kind":2048,"name":"getLocalAddress","url":"classes/httpclientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":416,"kind":2048,"name":"setLocalAddress","url":"classes/httpclientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":417,"kind":2048,"name":"getLogActivity","url":"classes/httpclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":418,"kind":2048,"name":"setLogActivity","url":"classes/httpclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":419,"kind":2048,"name":"getMaxChunkSize","url":"classes/httpclientoptions.html#getmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":420,"kind":2048,"name":"setMaxChunkSize","url":"classes/httpclientoptions.html#setmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":421,"kind":2048,"name":"getMaxHeaderSize","url":"classes/httpclientoptions.html#getmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":422,"kind":2048,"name":"setMaxHeaderSize","url":"classes/httpclientoptions.html#setmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":423,"kind":2048,"name":"getMaxInitialLineLength","url":"classes/httpclientoptions.html#getmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":424,"kind":2048,"name":"setMaxInitialLineLength","url":"classes/httpclientoptions.html#setmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":425,"kind":2048,"name":"getMaxPoolSize","url":"classes/httpclientoptions.html#getmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":426,"kind":2048,"name":"setMaxPoolSize","url":"classes/httpclientoptions.html#setmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":427,"kind":2048,"name":"getMaxRedirects","url":"classes/httpclientoptions.html#getmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":428,"kind":2048,"name":"setMaxRedirects","url":"classes/httpclientoptions.html#setmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":429,"kind":2048,"name":"getMaxWaitQueueSize","url":"classes/httpclientoptions.html#getmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":430,"kind":2048,"name":"setMaxWaitQueueSize","url":"classes/httpclientoptions.html#setmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":431,"kind":2048,"name":"getMaxWebsocketFrameSize","url":"classes/httpclientoptions.html#getmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":432,"kind":2048,"name":"setMaxWebsocketFrameSize","url":"classes/httpclientoptions.html#setmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":433,"kind":2048,"name":"getMaxWebsocketMessageSize","url":"classes/httpclientoptions.html#getmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":434,"kind":2048,"name":"setMaxWebsocketMessageSize","url":"classes/httpclientoptions.html#setmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":435,"kind":2048,"name":"getMetricsName","url":"classes/httpclientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":436,"kind":2048,"name":"setMetricsName","url":"classes/httpclientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":437,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/httpclientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":438,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/httpclientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":439,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/httpclientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":440,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/httpclientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":441,"kind":2048,"name":"getPemTrustOptions","url":"classes/httpclientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":442,"kind":2048,"name":"setPemTrustOptions","url":"classes/httpclientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":443,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/httpclientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":444,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/httpclientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":445,"kind":2048,"name":"getPfxTrustOptions","url":"classes/httpclientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":446,"kind":2048,"name":"setPfxTrustOptions","url":"classes/httpclientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":447,"kind":2048,"name":"isPipelining","url":"classes/httpclientoptions.html#ispipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":448,"kind":2048,"name":"setPipelining","url":"classes/httpclientoptions.html#setpipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":449,"kind":2048,"name":"getPipeliningLimit","url":"classes/httpclientoptions.html#getpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":450,"kind":2048,"name":"setPipeliningLimit","url":"classes/httpclientoptions.html#setpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":451,"kind":2048,"name":"getPoolCleanerPeriod","url":"classes/httpclientoptions.html#getpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":452,"kind":2048,"name":"setPoolCleanerPeriod","url":"classes/httpclientoptions.html#setpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":453,"kind":2048,"name":"getProtocolVersion","url":"classes/httpclientoptions.html#getprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":454,"kind":2048,"name":"setProtocolVersion","url":"classes/httpclientoptions.html#setprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":455,"kind":2048,"name":"getProxyOptions","url":"classes/httpclientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":456,"kind":2048,"name":"setProxyOptions","url":"classes/httpclientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":457,"kind":2048,"name":"getReceiveBufferSize","url":"classes/httpclientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":458,"kind":2048,"name":"setReceiveBufferSize","url":"classes/httpclientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":459,"kind":2048,"name":"isReuseAddress","url":"classes/httpclientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":460,"kind":2048,"name":"setReuseAddress","url":"classes/httpclientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":461,"kind":2048,"name":"isReusePort","url":"classes/httpclientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":462,"kind":2048,"name":"setReusePort","url":"classes/httpclientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":463,"kind":2048,"name":"getSendBufferSize","url":"classes/httpclientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":464,"kind":2048,"name":"setSendBufferSize","url":"classes/httpclientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":465,"kind":2048,"name":"isSendUnmaskedFrames","url":"classes/httpclientoptions.html#issendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":466,"kind":2048,"name":"setSendUnmaskedFrames","url":"classes/httpclientoptions.html#setsendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":467,"kind":2048,"name":"getSoLinger","url":"classes/httpclientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":468,"kind":2048,"name":"setSoLinger","url":"classes/httpclientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":469,"kind":2048,"name":"isSsl","url":"classes/httpclientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":470,"kind":2048,"name":"setSsl","url":"classes/httpclientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":471,"kind":2048,"name":"isTcpCork","url":"classes/httpclientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":472,"kind":2048,"name":"setTcpCork","url":"classes/httpclientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":473,"kind":2048,"name":"isTcpFastOpen","url":"classes/httpclientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":474,"kind":2048,"name":"setTcpFastOpen","url":"classes/httpclientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":475,"kind":2048,"name":"isTcpKeepAlive","url":"classes/httpclientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":476,"kind":2048,"name":"setTcpKeepAlive","url":"classes/httpclientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":477,"kind":2048,"name":"isTcpNoDelay","url":"classes/httpclientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":478,"kind":2048,"name":"setTcpNoDelay","url":"classes/httpclientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":479,"kind":2048,"name":"isTcpQuickAck","url":"classes/httpclientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":480,"kind":2048,"name":"setTcpQuickAck","url":"classes/httpclientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":481,"kind":2048,"name":"getTrafficClass","url":"classes/httpclientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":482,"kind":2048,"name":"setTrafficClass","url":"classes/httpclientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":483,"kind":2048,"name":"isTrustAll","url":"classes/httpclientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":484,"kind":2048,"name":"setTrustAll","url":"classes/httpclientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":485,"kind":2048,"name":"getTrustStoreOptions","url":"classes/httpclientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":486,"kind":2048,"name":"setTrustStoreOptions","url":"classes/httpclientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":487,"kind":2048,"name":"isTryUseCompression","url":"classes/httpclientoptions.html#istryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":488,"kind":2048,"name":"setTryUseCompression","url":"classes/httpclientoptions.html#settryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":489,"kind":2048,"name":"tryUsePerFrameWebsocketCompression","url":"classes/httpclientoptions.html#tryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":490,"kind":2048,"name":"setTryUsePerFrameWebsocketCompression","url":"classes/httpclientoptions.html#settryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":491,"kind":2048,"name":"tryUsePerMessageWebsocketCompression","url":"classes/httpclientoptions.html#tryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":492,"kind":2048,"name":"setTryUsePerMessageWebsocketCompression","url":"classes/httpclientoptions.html#settryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":493,"kind":2048,"name":"isUseAlpn","url":"classes/httpclientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":494,"kind":2048,"name":"setUseAlpn","url":"classes/httpclientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":495,"kind":2048,"name":"isUsePooledBuffers","url":"classes/httpclientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":496,"kind":2048,"name":"setUsePooledBuffers","url":"classes/httpclientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":497,"kind":2048,"name":"isVerifyHost","url":"classes/httpclientoptions.html#isverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":498,"kind":2048,"name":"setVerifyHost","url":"classes/httpclientoptions.html#setverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":499,"kind":2048,"name":"getWebsocketCompressionAllowClientNoContext","url":"classes/httpclientoptions.html#getwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":500,"kind":2048,"name":"setWebsocketCompressionAllowClientNoContext","url":"classes/httpclientoptions.html#setwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":501,"kind":2048,"name":"getWebsocketCompressionLevel","url":"classes/httpclientoptions.html#getwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":502,"kind":2048,"name":"setWebsocketCompressionLevel","url":"classes/httpclientoptions.html#setwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":503,"kind":2048,"name":"getWebsocketCompressionRequestServerNoContext","url":"classes/httpclientoptions.html#getwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":504,"kind":2048,"name":"setWebsocketCompressionRequestServerNoContext","url":"classes/httpclientoptions.html#setwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientOptions"},{"id":505,"kind":128,"name":"HttpServerOptions","url":"classes/httpserveroptions.html","classes":"tsd-kind-class"},{"id":506,"kind":512,"name":"constructor","url":"classes/httpserveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":507,"kind":2048,"name":"getAcceptBacklog","url":"classes/httpserveroptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":508,"kind":2048,"name":"setAcceptBacklog","url":"classes/httpserveroptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":509,"kind":2048,"name":"isAcceptUnmaskedFrames","url":"classes/httpserveroptions.html#isacceptunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":510,"kind":2048,"name":"setAcceptUnmaskedFrames","url":"classes/httpserveroptions.html#setacceptunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":511,"kind":2048,"name":"getAlpnVersions","url":"classes/httpserveroptions.html#getalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":512,"kind":2048,"name":"setAlpnVersions","url":"classes/httpserveroptions.html#setalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":513,"kind":2048,"name":"getClientAuth","url":"classes/httpserveroptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":514,"kind":2048,"name":"setClientAuth","url":"classes/httpserveroptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":515,"kind":2048,"name":"isClientAuthRequired","url":"classes/httpserveroptions.html#isclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":516,"kind":2048,"name":"setClientAuthRequired","url":"classes/httpserveroptions.html#setclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":517,"kind":2048,"name":"getCompressionLevel","url":"classes/httpserveroptions.html#getcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":518,"kind":2048,"name":"setCompressionLevel","url":"classes/httpserveroptions.html#setcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":519,"kind":2048,"name":"isCompressionSupported","url":"classes/httpserveroptions.html#iscompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":520,"kind":2048,"name":"setCompressionSupported","url":"classes/httpserveroptions.html#setcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":521,"kind":2048,"name":"getCrlPaths","url":"classes/httpserveroptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":522,"kind":2048,"name":"addCrlPath","url":"classes/httpserveroptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":523,"kind":2048,"name":"getCrlValues","url":"classes/httpserveroptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":524,"kind":2048,"name":"addCrlValue","url":"classes/httpserveroptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":525,"kind":2048,"name":"getDecoderInitialBufferSize","url":"classes/httpserveroptions.html#getdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":526,"kind":2048,"name":"setDecoderInitialBufferSize","url":"classes/httpserveroptions.html#setdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":527,"kind":2048,"name":"isDecompressionSupported","url":"classes/httpserveroptions.html#isdecompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":528,"kind":2048,"name":"setDecompressionSupported","url":"classes/httpserveroptions.html#setdecompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":529,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/httpserveroptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":530,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/httpserveroptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":531,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/httpserveroptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":532,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/httpserveroptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":533,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/httpserveroptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":534,"kind":2048,"name":"isHandle100ContinueAutomatically","url":"classes/httpserveroptions.html#ishandle100continueautomatically","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":535,"kind":2048,"name":"setHandle100ContinueAutomatically","url":"classes/httpserveroptions.html#sethandle100continueautomatically","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":536,"kind":2048,"name":"getHost","url":"classes/httpserveroptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":537,"kind":2048,"name":"setHost","url":"classes/httpserveroptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":538,"kind":2048,"name":"getHttp2ConnectionWindowSize","url":"classes/httpserveroptions.html#gethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":539,"kind":2048,"name":"setHttp2ConnectionWindowSize","url":"classes/httpserveroptions.html#sethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":540,"kind":2048,"name":"getIdleTimeout","url":"classes/httpserveroptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":541,"kind":2048,"name":"setIdleTimeout","url":"classes/httpserveroptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":542,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/httpserveroptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":543,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/httpserveroptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":544,"kind":2048,"name":"getInitialSettings","url":"classes/httpserveroptions.html#getinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":545,"kind":2048,"name":"setInitialSettings","url":"classes/httpserveroptions.html#setinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":546,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/httpserveroptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":547,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/httpserveroptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":548,"kind":2048,"name":"getKeyStoreOptions","url":"classes/httpserveroptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":549,"kind":2048,"name":"setKeyStoreOptions","url":"classes/httpserveroptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":550,"kind":2048,"name":"getLogActivity","url":"classes/httpserveroptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":551,"kind":2048,"name":"setLogActivity","url":"classes/httpserveroptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":552,"kind":2048,"name":"getMaxChunkSize","url":"classes/httpserveroptions.html#getmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":553,"kind":2048,"name":"setMaxChunkSize","url":"classes/httpserveroptions.html#setmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":554,"kind":2048,"name":"getMaxHeaderSize","url":"classes/httpserveroptions.html#getmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":555,"kind":2048,"name":"setMaxHeaderSize","url":"classes/httpserveroptions.html#setmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":556,"kind":2048,"name":"getMaxInitialLineLength","url":"classes/httpserveroptions.html#getmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":557,"kind":2048,"name":"setMaxInitialLineLength","url":"classes/httpserveroptions.html#setmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":558,"kind":2048,"name":"getMaxWebsocketFrameSize","url":"classes/httpserveroptions.html#getmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":559,"kind":2048,"name":"setMaxWebsocketFrameSize","url":"classes/httpserveroptions.html#setmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":560,"kind":2048,"name":"getMaxWebsocketMessageSize","url":"classes/httpserveroptions.html#getmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":561,"kind":2048,"name":"setMaxWebsocketMessageSize","url":"classes/httpserveroptions.html#setmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":562,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/httpserveroptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":563,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/httpserveroptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":564,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/httpserveroptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":565,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/httpserveroptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":566,"kind":2048,"name":"getPemTrustOptions","url":"classes/httpserveroptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":567,"kind":2048,"name":"setPemTrustOptions","url":"classes/httpserveroptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":568,"kind":2048,"name":"perFrameWebsocketCompressionSupported","url":"classes/httpserveroptions.html#perframewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":569,"kind":2048,"name":"setPerFrameWebsocketCompressionSupported","url":"classes/httpserveroptions.html#setperframewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":570,"kind":2048,"name":"perMessageWebsocketCompressionSupported","url":"classes/httpserveroptions.html#permessagewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":571,"kind":2048,"name":"setPerMessageWebsocketCompressionSupported","url":"classes/httpserveroptions.html#setpermessagewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":572,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/httpserveroptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":573,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/httpserveroptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":574,"kind":2048,"name":"getPfxTrustOptions","url":"classes/httpserveroptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":575,"kind":2048,"name":"setPfxTrustOptions","url":"classes/httpserveroptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":576,"kind":2048,"name":"getPort","url":"classes/httpserveroptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":577,"kind":2048,"name":"setPort","url":"classes/httpserveroptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":578,"kind":2048,"name":"getReceiveBufferSize","url":"classes/httpserveroptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":579,"kind":2048,"name":"setReceiveBufferSize","url":"classes/httpserveroptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":580,"kind":2048,"name":"isReuseAddress","url":"classes/httpserveroptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":581,"kind":2048,"name":"setReuseAddress","url":"classes/httpserveroptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":582,"kind":2048,"name":"isReusePort","url":"classes/httpserveroptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":583,"kind":2048,"name":"setReusePort","url":"classes/httpserveroptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":584,"kind":2048,"name":"getSendBufferSize","url":"classes/httpserveroptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":585,"kind":2048,"name":"setSendBufferSize","url":"classes/httpserveroptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":586,"kind":2048,"name":"isSni","url":"classes/httpserveroptions.html#issni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":587,"kind":2048,"name":"setSni","url":"classes/httpserveroptions.html#setsni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":588,"kind":2048,"name":"getSoLinger","url":"classes/httpserveroptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":589,"kind":2048,"name":"setSoLinger","url":"classes/httpserveroptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":590,"kind":2048,"name":"isSsl","url":"classes/httpserveroptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":591,"kind":2048,"name":"setSsl","url":"classes/httpserveroptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":592,"kind":2048,"name":"isTcpCork","url":"classes/httpserveroptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":593,"kind":2048,"name":"setTcpCork","url":"classes/httpserveroptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":594,"kind":2048,"name":"isTcpFastOpen","url":"classes/httpserveroptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":595,"kind":2048,"name":"setTcpFastOpen","url":"classes/httpserveroptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":596,"kind":2048,"name":"isTcpKeepAlive","url":"classes/httpserveroptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":597,"kind":2048,"name":"setTcpKeepAlive","url":"classes/httpserveroptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":598,"kind":2048,"name":"isTcpNoDelay","url":"classes/httpserveroptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":599,"kind":2048,"name":"setTcpNoDelay","url":"classes/httpserveroptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":600,"kind":2048,"name":"isTcpQuickAck","url":"classes/httpserveroptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":601,"kind":2048,"name":"setTcpQuickAck","url":"classes/httpserveroptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":602,"kind":2048,"name":"getTrafficClass","url":"classes/httpserveroptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":603,"kind":2048,"name":"setTrafficClass","url":"classes/httpserveroptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":604,"kind":2048,"name":"getTrustStoreOptions","url":"classes/httpserveroptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":605,"kind":2048,"name":"setTrustStoreOptions","url":"classes/httpserveroptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":606,"kind":2048,"name":"isUseAlpn","url":"classes/httpserveroptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":607,"kind":2048,"name":"setUseAlpn","url":"classes/httpserveroptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":608,"kind":2048,"name":"isUsePooledBuffers","url":"classes/httpserveroptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":609,"kind":2048,"name":"setUsePooledBuffers","url":"classes/httpserveroptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":610,"kind":2048,"name":"getWebsocketAllowServerNoContext","url":"classes/httpserveroptions.html#getwebsocketallowservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":611,"kind":2048,"name":"setWebsocketAllowServerNoContext","url":"classes/httpserveroptions.html#setwebsocketallowservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":612,"kind":2048,"name":"websocketCompressionLevel","url":"classes/httpserveroptions.html#websocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":613,"kind":2048,"name":"setWebsocketCompressionLevel","url":"classes/httpserveroptions.html#setwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":614,"kind":2048,"name":"getWebsocketPreferredClientNoContext","url":"classes/httpserveroptions.html#getwebsocketpreferredclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":615,"kind":2048,"name":"setWebsocketPreferredClientNoContext","url":"classes/httpserveroptions.html#setwebsocketpreferredclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":616,"kind":2048,"name":"getWebsocketSubProtocols","url":"classes/httpserveroptions.html#getwebsocketsubprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":617,"kind":2048,"name":"setWebsocketSubProtocols","url":"classes/httpserveroptions.html#setwebsocketsubprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerOptions"},{"id":618,"kind":128,"name":"JdkSSLEngineOptions","url":"classes/jdksslengineoptions.html","classes":"tsd-kind-class"},{"id":619,"kind":512,"name":"constructor","url":"classes/jdksslengineoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JdkSSLEngineOptions"},{"id":620,"kind":128,"name":"JksOptions","url":"classes/jksoptions.html","classes":"tsd-kind-class"},{"id":621,"kind":512,"name":"constructor","url":"classes/jksoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JksOptions"},{"id":622,"kind":2048,"name":"getPassword","url":"classes/jksoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JksOptions"},{"id":623,"kind":2048,"name":"setPassword","url":"classes/jksoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JksOptions"},{"id":624,"kind":2048,"name":"getPath","url":"classes/jksoptions.html#getpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JksOptions"},{"id":625,"kind":2048,"name":"setPath","url":"classes/jksoptions.html#setpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JksOptions"},{"id":626,"kind":2048,"name":"getValue","url":"classes/jksoptions.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JksOptions"},{"id":627,"kind":2048,"name":"setValue","url":"classes/jksoptions.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JksOptions"},{"id":628,"kind":128,"name":"MetricsOptions","url":"classes/metricsoptions.html","classes":"tsd-kind-class"},{"id":629,"kind":512,"name":"constructor","url":"classes/metricsoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MetricsOptions"},{"id":630,"kind":2048,"name":"isEnabled","url":"classes/metricsoptions.html#isenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsOptions"},{"id":631,"kind":2048,"name":"setEnabled","url":"classes/metricsoptions.html#setenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsOptions"},{"id":632,"kind":128,"name":"NetClientOptions","url":"classes/netclientoptions.html","classes":"tsd-kind-class"},{"id":633,"kind":512,"name":"constructor","url":"classes/netclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"NetClientOptions"},{"id":634,"kind":2048,"name":"getConnectTimeout","url":"classes/netclientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":635,"kind":2048,"name":"setConnectTimeout","url":"classes/netclientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":636,"kind":2048,"name":"getCrlPaths","url":"classes/netclientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":637,"kind":2048,"name":"addCrlPath","url":"classes/netclientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":638,"kind":2048,"name":"getCrlValues","url":"classes/netclientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":639,"kind":2048,"name":"addCrlValue","url":"classes/netclientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":640,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/netclientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":641,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/netclientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":642,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/netclientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":643,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/netclientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":644,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/netclientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":645,"kind":2048,"name":"getHostnameVerificationAlgorithm","url":"classes/netclientoptions.html#gethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":646,"kind":2048,"name":"setHostnameVerificationAlgorithm","url":"classes/netclientoptions.html#sethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":647,"kind":2048,"name":"getIdleTimeout","url":"classes/netclientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":648,"kind":2048,"name":"setIdleTimeout","url":"classes/netclientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":649,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/netclientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":650,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/netclientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":651,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/netclientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":652,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/netclientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":653,"kind":2048,"name":"getKeyStoreOptions","url":"classes/netclientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":654,"kind":2048,"name":"setKeyStoreOptions","url":"classes/netclientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":655,"kind":2048,"name":"getLocalAddress","url":"classes/netclientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":656,"kind":2048,"name":"setLocalAddress","url":"classes/netclientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":657,"kind":2048,"name":"getLogActivity","url":"classes/netclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":658,"kind":2048,"name":"setLogActivity","url":"classes/netclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":659,"kind":2048,"name":"getMetricsName","url":"classes/netclientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":660,"kind":2048,"name":"setMetricsName","url":"classes/netclientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":661,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/netclientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":662,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/netclientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":663,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/netclientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":664,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/netclientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":665,"kind":2048,"name":"getPemTrustOptions","url":"classes/netclientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":666,"kind":2048,"name":"setPemTrustOptions","url":"classes/netclientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":667,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/netclientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":668,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/netclientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":669,"kind":2048,"name":"getPfxTrustOptions","url":"classes/netclientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":670,"kind":2048,"name":"setPfxTrustOptions","url":"classes/netclientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":671,"kind":2048,"name":"getProxyOptions","url":"classes/netclientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":672,"kind":2048,"name":"setProxyOptions","url":"classes/netclientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":673,"kind":2048,"name":"getReceiveBufferSize","url":"classes/netclientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":674,"kind":2048,"name":"setReceiveBufferSize","url":"classes/netclientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":675,"kind":2048,"name":"getReconnectAttempts","url":"classes/netclientoptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":676,"kind":2048,"name":"setReconnectAttempts","url":"classes/netclientoptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":677,"kind":2048,"name":"getReconnectInterval","url":"classes/netclientoptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":678,"kind":2048,"name":"setReconnectInterval","url":"classes/netclientoptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":679,"kind":2048,"name":"isReuseAddress","url":"classes/netclientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":680,"kind":2048,"name":"setReuseAddress","url":"classes/netclientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":681,"kind":2048,"name":"isReusePort","url":"classes/netclientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":682,"kind":2048,"name":"setReusePort","url":"classes/netclientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":683,"kind":2048,"name":"getSendBufferSize","url":"classes/netclientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":684,"kind":2048,"name":"setSendBufferSize","url":"classes/netclientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":685,"kind":2048,"name":"getSoLinger","url":"classes/netclientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":686,"kind":2048,"name":"setSoLinger","url":"classes/netclientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":687,"kind":2048,"name":"isSsl","url":"classes/netclientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":688,"kind":2048,"name":"setSsl","url":"classes/netclientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":689,"kind":2048,"name":"isTcpCork","url":"classes/netclientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":690,"kind":2048,"name":"setTcpCork","url":"classes/netclientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":691,"kind":2048,"name":"isTcpFastOpen","url":"classes/netclientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":692,"kind":2048,"name":"setTcpFastOpen","url":"classes/netclientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":693,"kind":2048,"name":"isTcpKeepAlive","url":"classes/netclientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":694,"kind":2048,"name":"setTcpKeepAlive","url":"classes/netclientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":695,"kind":2048,"name":"isTcpNoDelay","url":"classes/netclientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":696,"kind":2048,"name":"setTcpNoDelay","url":"classes/netclientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":697,"kind":2048,"name":"isTcpQuickAck","url":"classes/netclientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":698,"kind":2048,"name":"setTcpQuickAck","url":"classes/netclientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":699,"kind":2048,"name":"getTrafficClass","url":"classes/netclientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":700,"kind":2048,"name":"setTrafficClass","url":"classes/netclientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":701,"kind":2048,"name":"isTrustAll","url":"classes/netclientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":702,"kind":2048,"name":"setTrustAll","url":"classes/netclientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":703,"kind":2048,"name":"getTrustStoreOptions","url":"classes/netclientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":704,"kind":2048,"name":"setTrustStoreOptions","url":"classes/netclientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":705,"kind":2048,"name":"isUseAlpn","url":"classes/netclientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":706,"kind":2048,"name":"setUseAlpn","url":"classes/netclientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":707,"kind":2048,"name":"isUsePooledBuffers","url":"classes/netclientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":708,"kind":2048,"name":"setUsePooledBuffers","url":"classes/netclientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClientOptions"},{"id":709,"kind":128,"name":"NetServerOptions","url":"classes/netserveroptions.html","classes":"tsd-kind-class"},{"id":710,"kind":512,"name":"constructor","url":"classes/netserveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"NetServerOptions"},{"id":711,"kind":2048,"name":"getAcceptBacklog","url":"classes/netserveroptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":712,"kind":2048,"name":"setAcceptBacklog","url":"classes/netserveroptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":713,"kind":2048,"name":"getClientAuth","url":"classes/netserveroptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":714,"kind":2048,"name":"setClientAuth","url":"classes/netserveroptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":715,"kind":2048,"name":"isClientAuthRequired","url":"classes/netserveroptions.html#isclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":716,"kind":2048,"name":"setClientAuthRequired","url":"classes/netserveroptions.html#setclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":717,"kind":2048,"name":"getCrlPaths","url":"classes/netserveroptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":718,"kind":2048,"name":"addCrlPath","url":"classes/netserveroptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":719,"kind":2048,"name":"getCrlValues","url":"classes/netserveroptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":720,"kind":2048,"name":"addCrlValue","url":"classes/netserveroptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":721,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/netserveroptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":722,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/netserveroptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":723,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/netserveroptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":724,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/netserveroptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":725,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/netserveroptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":726,"kind":2048,"name":"getHost","url":"classes/netserveroptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":727,"kind":2048,"name":"setHost","url":"classes/netserveroptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":728,"kind":2048,"name":"getIdleTimeout","url":"classes/netserveroptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":729,"kind":2048,"name":"setIdleTimeout","url":"classes/netserveroptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":730,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/netserveroptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":731,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/netserveroptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":732,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/netserveroptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":733,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/netserveroptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":734,"kind":2048,"name":"getKeyStoreOptions","url":"classes/netserveroptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":735,"kind":2048,"name":"setKeyStoreOptions","url":"classes/netserveroptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":736,"kind":2048,"name":"getLogActivity","url":"classes/netserveroptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":737,"kind":2048,"name":"setLogActivity","url":"classes/netserveroptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":738,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/netserveroptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":739,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/netserveroptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":740,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/netserveroptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":741,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/netserveroptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":742,"kind":2048,"name":"getPemTrustOptions","url":"classes/netserveroptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":743,"kind":2048,"name":"setPemTrustOptions","url":"classes/netserveroptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":744,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/netserveroptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":745,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/netserveroptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":746,"kind":2048,"name":"getPfxTrustOptions","url":"classes/netserveroptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":747,"kind":2048,"name":"setPfxTrustOptions","url":"classes/netserveroptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":748,"kind":2048,"name":"getPort","url":"classes/netserveroptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":749,"kind":2048,"name":"setPort","url":"classes/netserveroptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":750,"kind":2048,"name":"getReceiveBufferSize","url":"classes/netserveroptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":751,"kind":2048,"name":"setReceiveBufferSize","url":"classes/netserveroptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":752,"kind":2048,"name":"isReuseAddress","url":"classes/netserveroptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":753,"kind":2048,"name":"setReuseAddress","url":"classes/netserveroptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":754,"kind":2048,"name":"isReusePort","url":"classes/netserveroptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":755,"kind":2048,"name":"setReusePort","url":"classes/netserveroptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":756,"kind":2048,"name":"getSendBufferSize","url":"classes/netserveroptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":757,"kind":2048,"name":"setSendBufferSize","url":"classes/netserveroptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":758,"kind":2048,"name":"isSni","url":"classes/netserveroptions.html#issni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":759,"kind":2048,"name":"setSni","url":"classes/netserveroptions.html#setsni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":760,"kind":2048,"name":"getSoLinger","url":"classes/netserveroptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":761,"kind":2048,"name":"setSoLinger","url":"classes/netserveroptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":762,"kind":2048,"name":"isSsl","url":"classes/netserveroptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":763,"kind":2048,"name":"setSsl","url":"classes/netserveroptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":764,"kind":2048,"name":"isTcpCork","url":"classes/netserveroptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":765,"kind":2048,"name":"setTcpCork","url":"classes/netserveroptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":766,"kind":2048,"name":"isTcpFastOpen","url":"classes/netserveroptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":767,"kind":2048,"name":"setTcpFastOpen","url":"classes/netserveroptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":768,"kind":2048,"name":"isTcpKeepAlive","url":"classes/netserveroptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":769,"kind":2048,"name":"setTcpKeepAlive","url":"classes/netserveroptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":770,"kind":2048,"name":"isTcpNoDelay","url":"classes/netserveroptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":771,"kind":2048,"name":"setTcpNoDelay","url":"classes/netserveroptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":772,"kind":2048,"name":"isTcpQuickAck","url":"classes/netserveroptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":773,"kind":2048,"name":"setTcpQuickAck","url":"classes/netserveroptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":774,"kind":2048,"name":"getTrafficClass","url":"classes/netserveroptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":775,"kind":2048,"name":"setTrafficClass","url":"classes/netserveroptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":776,"kind":2048,"name":"getTrustStoreOptions","url":"classes/netserveroptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":777,"kind":2048,"name":"setTrustStoreOptions","url":"classes/netserveroptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":778,"kind":2048,"name":"isUseAlpn","url":"classes/netserveroptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":779,"kind":2048,"name":"setUseAlpn","url":"classes/netserveroptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":780,"kind":2048,"name":"isUsePooledBuffers","url":"classes/netserveroptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":781,"kind":2048,"name":"setUsePooledBuffers","url":"classes/netserveroptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServerOptions"},{"id":782,"kind":128,"name":"NetworkOptions","url":"classes/networkoptions.html","classes":"tsd-kind-class"},{"id":783,"kind":512,"name":"constructor","url":"classes/networkoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"NetworkOptions"},{"id":784,"kind":2048,"name":"getLogActivity","url":"classes/networkoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":785,"kind":2048,"name":"setLogActivity","url":"classes/networkoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":786,"kind":2048,"name":"getReceiveBufferSize","url":"classes/networkoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":787,"kind":2048,"name":"setReceiveBufferSize","url":"classes/networkoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":788,"kind":2048,"name":"isReuseAddress","url":"classes/networkoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":789,"kind":2048,"name":"setReuseAddress","url":"classes/networkoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":790,"kind":2048,"name":"isReusePort","url":"classes/networkoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":791,"kind":2048,"name":"setReusePort","url":"classes/networkoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":792,"kind":2048,"name":"getSendBufferSize","url":"classes/networkoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":793,"kind":2048,"name":"setSendBufferSize","url":"classes/networkoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":794,"kind":2048,"name":"getTrafficClass","url":"classes/networkoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":795,"kind":2048,"name":"setTrafficClass","url":"classes/networkoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetworkOptions"},{"id":796,"kind":128,"name":"OpenOptions","url":"classes/openoptions.html","classes":"tsd-kind-class"},{"id":797,"kind":512,"name":"constructor","url":"classes/openoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OpenOptions"},{"id":798,"kind":2048,"name":"isAppend","url":"classes/openoptions.html#isappend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":799,"kind":2048,"name":"setAppend","url":"classes/openoptions.html#setappend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":800,"kind":2048,"name":"isCreate","url":"classes/openoptions.html#iscreate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":801,"kind":2048,"name":"setCreate","url":"classes/openoptions.html#setcreate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":802,"kind":2048,"name":"isCreateNew","url":"classes/openoptions.html#iscreatenew","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":803,"kind":2048,"name":"setCreateNew","url":"classes/openoptions.html#setcreatenew","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":804,"kind":2048,"name":"isDeleteOnClose","url":"classes/openoptions.html#isdeleteonclose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":805,"kind":2048,"name":"setDeleteOnClose","url":"classes/openoptions.html#setdeleteonclose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":806,"kind":2048,"name":"isDsync","url":"classes/openoptions.html#isdsync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":807,"kind":2048,"name":"setDsync","url":"classes/openoptions.html#setdsync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":808,"kind":2048,"name":"getPerms","url":"classes/openoptions.html#getperms","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":809,"kind":2048,"name":"setPerms","url":"classes/openoptions.html#setperms","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":810,"kind":2048,"name":"isRead","url":"classes/openoptions.html#isread","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":811,"kind":2048,"name":"setRead","url":"classes/openoptions.html#setread","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":812,"kind":2048,"name":"isSparse","url":"classes/openoptions.html#issparse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":813,"kind":2048,"name":"setSparse","url":"classes/openoptions.html#setsparse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":814,"kind":2048,"name":"isSync","url":"classes/openoptions.html#issync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":815,"kind":2048,"name":"setSync","url":"classes/openoptions.html#setsync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":816,"kind":2048,"name":"isTruncateExisting","url":"classes/openoptions.html#istruncateexisting","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":817,"kind":2048,"name":"setTruncateExisting","url":"classes/openoptions.html#settruncateexisting","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":818,"kind":2048,"name":"isWrite","url":"classes/openoptions.html#iswrite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":819,"kind":2048,"name":"setWrite","url":"classes/openoptions.html#setwrite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenOptions"},{"id":820,"kind":128,"name":"OpenSSLEngineOptions","url":"classes/opensslengineoptions.html","classes":"tsd-kind-class"},{"id":821,"kind":512,"name":"constructor","url":"classes/opensslengineoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OpenSSLEngineOptions"},{"id":822,"kind":2048,"name":"isSessionCacheEnabled","url":"classes/opensslengineoptions.html#issessioncacheenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenSSLEngineOptions"},{"id":823,"kind":2048,"name":"setSessionCacheEnabled","url":"classes/opensslengineoptions.html#setsessioncacheenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenSSLEngineOptions"},{"id":824,"kind":128,"name":"Option","url":"classes/option.html","classes":"tsd-kind-class"},{"id":825,"kind":512,"name":"constructor","url":"classes/option.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Option"},{"id":826,"kind":2048,"name":"getArgName","url":"classes/option.html#getargname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":827,"kind":2048,"name":"setArgName","url":"classes/option.html#setargname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":828,"kind":2048,"name":"getChoices","url":"classes/option.html#getchoices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":829,"kind":2048,"name":"setChoices","url":"classes/option.html#setchoices","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":830,"kind":2048,"name":"addChoice","url":"classes/option.html#addchoice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":831,"kind":2048,"name":"getDefaultValue","url":"classes/option.html#getdefaultvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":832,"kind":2048,"name":"setDefaultValue","url":"classes/option.html#setdefaultvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":833,"kind":2048,"name":"getDescription","url":"classes/option.html#getdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":834,"kind":2048,"name":"setDescription","url":"classes/option.html#setdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":835,"kind":2048,"name":"isFlag","url":"classes/option.html#isflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":836,"kind":2048,"name":"setFlag","url":"classes/option.html#setflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":837,"kind":2048,"name":"isHelp","url":"classes/option.html#ishelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":838,"kind":2048,"name":"setHelp","url":"classes/option.html#sethelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":839,"kind":2048,"name":"isHidden","url":"classes/option.html#ishidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":840,"kind":2048,"name":"setHidden","url":"classes/option.html#sethidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":841,"kind":2048,"name":"getLongName","url":"classes/option.html#getlongname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":842,"kind":2048,"name":"setLongName","url":"classes/option.html#setlongname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":843,"kind":2048,"name":"isMultiValued","url":"classes/option.html#ismultivalued","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":844,"kind":2048,"name":"setMultiValued","url":"classes/option.html#setmultivalued","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":845,"kind":2048,"name":"getName","url":"classes/option.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":846,"kind":2048,"name":"isRequired","url":"classes/option.html#isrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":847,"kind":2048,"name":"setRequired","url":"classes/option.html#setrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":848,"kind":2048,"name":"getShortName","url":"classes/option.html#getshortname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":849,"kind":2048,"name":"setShortName","url":"classes/option.html#setshortname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":850,"kind":2048,"name":"isSingleValued","url":"classes/option.html#issinglevalued","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":851,"kind":2048,"name":"setSingleValued","url":"classes/option.html#setsinglevalued","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Option"},{"id":852,"kind":128,"name":"PemKeyCertOptions","url":"classes/pemkeycertoptions.html","classes":"tsd-kind-class"},{"id":853,"kind":512,"name":"constructor","url":"classes/pemkeycertoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":854,"kind":2048,"name":"certPath","url":"classes/pemkeycertoptions.html#certpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":855,"kind":2048,"name":"setCertPath","url":"classes/pemkeycertoptions.html#setcertpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":856,"kind":2048,"name":"getCertPaths","url":"classes/pemkeycertoptions.html#getcertpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":857,"kind":2048,"name":"setCertPaths","url":"classes/pemkeycertoptions.html#setcertpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":858,"kind":2048,"name":"certValue","url":"classes/pemkeycertoptions.html#certvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":859,"kind":2048,"name":"setCertValue","url":"classes/pemkeycertoptions.html#setcertvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":860,"kind":2048,"name":"getCertValues","url":"classes/pemkeycertoptions.html#getcertvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":861,"kind":2048,"name":"setCertValues","url":"classes/pemkeycertoptions.html#setcertvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":862,"kind":2048,"name":"keyPath","url":"classes/pemkeycertoptions.html#keypath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":863,"kind":2048,"name":"setKeyPath","url":"classes/pemkeycertoptions.html#setkeypath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":864,"kind":2048,"name":"getKeyPaths","url":"classes/pemkeycertoptions.html#getkeypaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":865,"kind":2048,"name":"setKeyPaths","url":"classes/pemkeycertoptions.html#setkeypaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":866,"kind":2048,"name":"keyValue","url":"classes/pemkeycertoptions.html#keyvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":867,"kind":2048,"name":"setKeyValue","url":"classes/pemkeycertoptions.html#setkeyvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":868,"kind":2048,"name":"getKeyValues","url":"classes/pemkeycertoptions.html#getkeyvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":869,"kind":2048,"name":"setKeyValues","url":"classes/pemkeycertoptions.html#setkeyvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemKeyCertOptions"},{"id":870,"kind":128,"name":"PemTrustOptions","url":"classes/pemtrustoptions.html","classes":"tsd-kind-class"},{"id":871,"kind":512,"name":"constructor","url":"classes/pemtrustoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":872,"kind":2048,"name":"getCertPaths","url":"classes/pemtrustoptions.html#getcertpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":873,"kind":2048,"name":"addCertPath","url":"classes/pemtrustoptions.html#addcertpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":874,"kind":2048,"name":"getCertValues","url":"classes/pemtrustoptions.html#getcertvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":875,"kind":2048,"name":"addCertValue","url":"classes/pemtrustoptions.html#addcertvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PemTrustOptions"},{"id":876,"kind":128,"name":"PfxOptions","url":"classes/pfxoptions.html","classes":"tsd-kind-class"},{"id":877,"kind":512,"name":"constructor","url":"classes/pfxoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PfxOptions"},{"id":878,"kind":2048,"name":"getPassword","url":"classes/pfxoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PfxOptions"},{"id":879,"kind":2048,"name":"setPassword","url":"classes/pfxoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PfxOptions"},{"id":880,"kind":2048,"name":"getPath","url":"classes/pfxoptions.html#getpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PfxOptions"},{"id":881,"kind":2048,"name":"setPath","url":"classes/pfxoptions.html#setpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PfxOptions"},{"id":882,"kind":2048,"name":"getValue","url":"classes/pfxoptions.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PfxOptions"},{"id":883,"kind":2048,"name":"setValue","url":"classes/pfxoptions.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PfxOptions"},{"id":884,"kind":128,"name":"ProxyOptions","url":"classes/proxyoptions.html","classes":"tsd-kind-class"},{"id":885,"kind":512,"name":"constructor","url":"classes/proxyoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ProxyOptions"},{"id":886,"kind":2048,"name":"getHost","url":"classes/proxyoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":887,"kind":2048,"name":"setHost","url":"classes/proxyoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":888,"kind":2048,"name":"getPassword","url":"classes/proxyoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":889,"kind":2048,"name":"setPassword","url":"classes/proxyoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":890,"kind":2048,"name":"getPort","url":"classes/proxyoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":891,"kind":2048,"name":"setPort","url":"classes/proxyoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":892,"kind":2048,"name":"getType","url":"classes/proxyoptions.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":893,"kind":2048,"name":"setType","url":"classes/proxyoptions.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":894,"kind":2048,"name":"getUsername","url":"classes/proxyoptions.html#getusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":895,"kind":2048,"name":"setUsername","url":"classes/proxyoptions.html#setusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ProxyOptions"},{"id":896,"kind":128,"name":"RequestOptions","url":"classes/requestoptions.html","classes":"tsd-kind-class"},{"id":897,"kind":512,"name":"constructor","url":"classes/requestoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RequestOptions"},{"id":898,"kind":2048,"name":"getHost","url":"classes/requestoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":899,"kind":2048,"name":"setHost","url":"classes/requestoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":900,"kind":2048,"name":"getPort","url":"classes/requestoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":901,"kind":2048,"name":"setPort","url":"classes/requestoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":902,"kind":2048,"name":"isSsl","url":"classes/requestoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":903,"kind":2048,"name":"setSsl","url":"classes/requestoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":904,"kind":2048,"name":"getURI","url":"classes/requestoptions.html#geturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":905,"kind":2048,"name":"setURI","url":"classes/requestoptions.html#seturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestOptions"},{"id":906,"kind":128,"name":"StreamPriority","url":"classes/streampriority.html","classes":"tsd-kind-class"},{"id":907,"kind":512,"name":"constructor","url":"classes/streampriority.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"StreamPriority"},{"id":908,"kind":2048,"name":"getDependency","url":"classes/streampriority.html#getdependency","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StreamPriority"},{"id":909,"kind":2048,"name":"setDependency","url":"classes/streampriority.html#setdependency","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StreamPriority"},{"id":910,"kind":2048,"name":"isExclusive","url":"classes/streampriority.html#isexclusive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StreamPriority"},{"id":911,"kind":2048,"name":"setExclusive","url":"classes/streampriority.html#setexclusive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StreamPriority"},{"id":912,"kind":2048,"name":"getWeight","url":"classes/streampriority.html#getweight","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StreamPriority"},{"id":913,"kind":2048,"name":"setWeight","url":"classes/streampriority.html#setweight","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StreamPriority"},{"id":914,"kind":128,"name":"TCPSSLOptions","url":"classes/tcpssloptions.html","classes":"tsd-kind-class"},{"id":915,"kind":512,"name":"constructor","url":"classes/tcpssloptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":916,"kind":2048,"name":"getCrlPaths","url":"classes/tcpssloptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":917,"kind":2048,"name":"addCrlPath","url":"classes/tcpssloptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":918,"kind":2048,"name":"getCrlValues","url":"classes/tcpssloptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":919,"kind":2048,"name":"addCrlValue","url":"classes/tcpssloptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":920,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/tcpssloptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":921,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/tcpssloptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":922,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/tcpssloptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":923,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/tcpssloptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":924,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/tcpssloptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":925,"kind":2048,"name":"getIdleTimeout","url":"classes/tcpssloptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":926,"kind":2048,"name":"setIdleTimeout","url":"classes/tcpssloptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":927,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/tcpssloptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":928,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/tcpssloptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":929,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/tcpssloptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":930,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/tcpssloptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":931,"kind":2048,"name":"getKeyStoreOptions","url":"classes/tcpssloptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":932,"kind":2048,"name":"setKeyStoreOptions","url":"classes/tcpssloptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":933,"kind":2048,"name":"getLogActivity","url":"classes/tcpssloptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":934,"kind":2048,"name":"setLogActivity","url":"classes/tcpssloptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":935,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/tcpssloptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":936,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/tcpssloptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":937,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/tcpssloptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":938,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/tcpssloptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":939,"kind":2048,"name":"getPemTrustOptions","url":"classes/tcpssloptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":940,"kind":2048,"name":"setPemTrustOptions","url":"classes/tcpssloptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":941,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/tcpssloptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":942,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/tcpssloptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":943,"kind":2048,"name":"getPfxTrustOptions","url":"classes/tcpssloptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":944,"kind":2048,"name":"setPfxTrustOptions","url":"classes/tcpssloptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":945,"kind":2048,"name":"getReceiveBufferSize","url":"classes/tcpssloptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":946,"kind":2048,"name":"setReceiveBufferSize","url":"classes/tcpssloptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":947,"kind":2048,"name":"isReuseAddress","url":"classes/tcpssloptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":948,"kind":2048,"name":"setReuseAddress","url":"classes/tcpssloptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":949,"kind":2048,"name":"isReusePort","url":"classes/tcpssloptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":950,"kind":2048,"name":"setReusePort","url":"classes/tcpssloptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":951,"kind":2048,"name":"getSendBufferSize","url":"classes/tcpssloptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":952,"kind":2048,"name":"setSendBufferSize","url":"classes/tcpssloptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":953,"kind":2048,"name":"getSoLinger","url":"classes/tcpssloptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":954,"kind":2048,"name":"setSoLinger","url":"classes/tcpssloptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":955,"kind":2048,"name":"isSsl","url":"classes/tcpssloptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":956,"kind":2048,"name":"setSsl","url":"classes/tcpssloptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":957,"kind":2048,"name":"isTcpCork","url":"classes/tcpssloptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":958,"kind":2048,"name":"setTcpCork","url":"classes/tcpssloptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":959,"kind":2048,"name":"isTcpFastOpen","url":"classes/tcpssloptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":960,"kind":2048,"name":"setTcpFastOpen","url":"classes/tcpssloptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":961,"kind":2048,"name":"isTcpKeepAlive","url":"classes/tcpssloptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":962,"kind":2048,"name":"setTcpKeepAlive","url":"classes/tcpssloptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":963,"kind":2048,"name":"isTcpNoDelay","url":"classes/tcpssloptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":964,"kind":2048,"name":"setTcpNoDelay","url":"classes/tcpssloptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":965,"kind":2048,"name":"isTcpQuickAck","url":"classes/tcpssloptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":966,"kind":2048,"name":"setTcpQuickAck","url":"classes/tcpssloptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":967,"kind":2048,"name":"getTrafficClass","url":"classes/tcpssloptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":968,"kind":2048,"name":"setTrafficClass","url":"classes/tcpssloptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":969,"kind":2048,"name":"getTrustStoreOptions","url":"classes/tcpssloptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":970,"kind":2048,"name":"setTrustStoreOptions","url":"classes/tcpssloptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":971,"kind":2048,"name":"isUseAlpn","url":"classes/tcpssloptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":972,"kind":2048,"name":"setUseAlpn","url":"classes/tcpssloptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":973,"kind":2048,"name":"isUsePooledBuffers","url":"classes/tcpssloptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":974,"kind":2048,"name":"setUsePooledBuffers","url":"classes/tcpssloptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TCPSSLOptions"},{"id":975,"kind":128,"name":"VertxOptions","url":"classes/vertxoptions.html","classes":"tsd-kind-class"},{"id":976,"kind":512,"name":"constructor","url":"classes/vertxoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"VertxOptions"},{"id":977,"kind":2048,"name":"getAddressResolverOptions","url":"classes/vertxoptions.html#getaddressresolveroptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":978,"kind":2048,"name":"setAddressResolverOptions","url":"classes/vertxoptions.html#setaddressresolveroptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":979,"kind":2048,"name":"getBlockedThreadCheckInterval","url":"classes/vertxoptions.html#getblockedthreadcheckinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":980,"kind":2048,"name":"setBlockedThreadCheckInterval","url":"classes/vertxoptions.html#setblockedthreadcheckinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":981,"kind":2048,"name":"getBlockedThreadCheckIntervalUnit","url":"classes/vertxoptions.html#getblockedthreadcheckintervalunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":982,"kind":2048,"name":"setBlockedThreadCheckIntervalUnit","url":"classes/vertxoptions.html#setblockedthreadcheckintervalunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":983,"kind":2048,"name":"getClusterHost","url":"classes/vertxoptions.html#getclusterhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":984,"kind":2048,"name":"setClusterHost","url":"classes/vertxoptions.html#setclusterhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":985,"kind":2048,"name":"getClusterPingInterval","url":"classes/vertxoptions.html#getclusterpinginterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":986,"kind":2048,"name":"setClusterPingInterval","url":"classes/vertxoptions.html#setclusterpinginterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":987,"kind":2048,"name":"getClusterPingReplyInterval","url":"classes/vertxoptions.html#getclusterpingreplyinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":988,"kind":2048,"name":"setClusterPingReplyInterval","url":"classes/vertxoptions.html#setclusterpingreplyinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":989,"kind":2048,"name":"getClusterPort","url":"classes/vertxoptions.html#getclusterport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":990,"kind":2048,"name":"setClusterPort","url":"classes/vertxoptions.html#setclusterport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":991,"kind":2048,"name":"getClusterPublicHost","url":"classes/vertxoptions.html#getclusterpublichost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":992,"kind":2048,"name":"setClusterPublicHost","url":"classes/vertxoptions.html#setclusterpublichost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":993,"kind":2048,"name":"getClusterPublicPort","url":"classes/vertxoptions.html#getclusterpublicport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":994,"kind":2048,"name":"setClusterPublicPort","url":"classes/vertxoptions.html#setclusterpublicport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":995,"kind":2048,"name":"isClustered","url":"classes/vertxoptions.html#isclustered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":996,"kind":2048,"name":"setClustered","url":"classes/vertxoptions.html#setclustered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":997,"kind":2048,"name":"getEventBusOptions","url":"classes/vertxoptions.html#geteventbusoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":998,"kind":2048,"name":"setEventBusOptions","url":"classes/vertxoptions.html#seteventbusoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":999,"kind":2048,"name":"getEventLoopPoolSize","url":"classes/vertxoptions.html#geteventlooppoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1000,"kind":2048,"name":"setEventLoopPoolSize","url":"classes/vertxoptions.html#seteventlooppoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1001,"kind":2048,"name":"isFileResolverCachingEnabled","url":"classes/vertxoptions.html#isfileresolvercachingenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1002,"kind":2048,"name":"setFileResolverCachingEnabled","url":"classes/vertxoptions.html#setfileresolvercachingenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1003,"kind":2048,"name":"getFileSystemOptions","url":"classes/vertxoptions.html#getfilesystemoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1004,"kind":2048,"name":"setFileSystemOptions","url":"classes/vertxoptions.html#setfilesystemoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1005,"kind":2048,"name":"isHAEnabled","url":"classes/vertxoptions.html#ishaenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1006,"kind":2048,"name":"setHAEnabled","url":"classes/vertxoptions.html#sethaenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1007,"kind":2048,"name":"getHAGroup","url":"classes/vertxoptions.html#gethagroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1008,"kind":2048,"name":"setHAGroup","url":"classes/vertxoptions.html#sethagroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1009,"kind":2048,"name":"getInternalBlockingPoolSize","url":"classes/vertxoptions.html#getinternalblockingpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1010,"kind":2048,"name":"setInternalBlockingPoolSize","url":"classes/vertxoptions.html#setinternalblockingpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1011,"kind":2048,"name":"getMaxEventLoopExecuteTime","url":"classes/vertxoptions.html#getmaxeventloopexecutetime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1012,"kind":2048,"name":"setMaxEventLoopExecuteTime","url":"classes/vertxoptions.html#setmaxeventloopexecutetime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1013,"kind":2048,"name":"getMaxEventLoopExecuteTimeUnit","url":"classes/vertxoptions.html#getmaxeventloopexecutetimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1014,"kind":2048,"name":"setMaxEventLoopExecuteTimeUnit","url":"classes/vertxoptions.html#setmaxeventloopexecutetimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1015,"kind":2048,"name":"getMaxWorkerExecuteTime","url":"classes/vertxoptions.html#getmaxworkerexecutetime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1016,"kind":2048,"name":"setMaxWorkerExecuteTime","url":"classes/vertxoptions.html#setmaxworkerexecutetime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1017,"kind":2048,"name":"getMaxWorkerExecuteTimeUnit","url":"classes/vertxoptions.html#getmaxworkerexecutetimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1018,"kind":2048,"name":"setMaxWorkerExecuteTimeUnit","url":"classes/vertxoptions.html#setmaxworkerexecutetimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1019,"kind":2048,"name":"getMetricsOptions","url":"classes/vertxoptions.html#getmetricsoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1020,"kind":2048,"name":"setMetricsOptions","url":"classes/vertxoptions.html#setmetricsoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1021,"kind":2048,"name":"getPreferNativeTransport","url":"classes/vertxoptions.html#getprefernativetransport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1022,"kind":2048,"name":"setPreferNativeTransport","url":"classes/vertxoptions.html#setprefernativetransport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1023,"kind":2048,"name":"getQuorumSize","url":"classes/vertxoptions.html#getquorumsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1024,"kind":2048,"name":"setQuorumSize","url":"classes/vertxoptions.html#setquorumsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1025,"kind":2048,"name":"getWarningExceptionTime","url":"classes/vertxoptions.html#getwarningexceptiontime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1026,"kind":2048,"name":"setWarningExceptionTime","url":"classes/vertxoptions.html#setwarningexceptiontime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1027,"kind":2048,"name":"getWarningExceptionTimeUnit","url":"classes/vertxoptions.html#getwarningexceptiontimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1028,"kind":2048,"name":"setWarningExceptionTimeUnit","url":"classes/vertxoptions.html#setwarningexceptiontimeunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1029,"kind":2048,"name":"getWorkerPoolSize","url":"classes/vertxoptions.html#getworkerpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1030,"kind":2048,"name":"setWorkerPoolSize","url":"classes/vertxoptions.html#setworkerpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxOptions"},{"id":1031,"kind":256,"name":"Handler","url":"interfaces/handler.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":1032,"kind":2048,"name":"handle","url":"interfaces/handler.html#handle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Handler"},{"id":1033,"kind":256,"name":"AsyncResult","url":"interfaces/asyncresult.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":1034,"kind":2048,"name":"succeeded","url":"interfaces/asyncresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":1035,"kind":2048,"name":"failed","url":"interfaces/asyncresult.html#failed","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":1036,"kind":2048,"name":"cause","url":"interfaces/asyncresult.html#cause","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":1037,"kind":2048,"name":"result","url":"interfaces/asyncresult.html#result","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"AsyncResult"},{"id":1038,"kind":128,"name":"AsyncFile","url":"classes/asyncfile.html","classes":"tsd-kind-class"},{"id":1039,"kind":2048,"name":"end","url":"classes/asyncfile.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1040,"kind":2048,"name":"writeQueueFull","url":"classes/asyncfile.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1041,"kind":2048,"name":"handler","url":"classes/asyncfile.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1042,"kind":2048,"name":"pause","url":"classes/asyncfile.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1043,"kind":2048,"name":"resume","url":"classes/asyncfile.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1044,"kind":2048,"name":"endHandler","url":"classes/asyncfile.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1045,"kind":2048,"name":"write","url":"classes/asyncfile.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1046,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/asyncfile.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1047,"kind":2048,"name":"drainHandler","url":"classes/asyncfile.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1048,"kind":2048,"name":"exceptionHandler","url":"classes/asyncfile.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1049,"kind":2048,"name":"fetch","url":"classes/asyncfile.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1050,"kind":2048,"name":"close","url":"classes/asyncfile.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1051,"kind":2048,"name":"read","url":"classes/asyncfile.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1052,"kind":2048,"name":"flush","url":"classes/asyncfile.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1053,"kind":2048,"name":"setReadPos","url":"classes/asyncfile.html#setreadpos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1054,"kind":2048,"name":"setWritePos","url":"classes/asyncfile.html#setwritepos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1055,"kind":2048,"name":"setReadBufferSize","url":"classes/asyncfile.html#setreadbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncFile"},{"id":1056,"kind":128,"name":"AsyncMap","url":"classes/asyncmap.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1057,"kind":2048,"name":"get","url":"classes/asyncmap.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1058,"kind":2048,"name":"put","url":"classes/asyncmap.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1059,"kind":2048,"name":"putIfAbsent","url":"classes/asyncmap.html#putifabsent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1060,"kind":2048,"name":"remove","url":"classes/asyncmap.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1061,"kind":2048,"name":"removeIfPresent","url":"classes/asyncmap.html#removeifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1062,"kind":2048,"name":"replace","url":"classes/asyncmap.html#replace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1063,"kind":2048,"name":"replaceIfPresent","url":"classes/asyncmap.html#replaceifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1064,"kind":2048,"name":"clear","url":"classes/asyncmap.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1065,"kind":2048,"name":"size","url":"classes/asyncmap.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AsyncMap"},{"id":1066,"kind":128,"name":"Buffer","url":"classes/buffer.html","classes":"tsd-kind-class"},{"id":1067,"kind":2048,"name":"buffer","url":"classes/buffer.html#buffer-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Buffer"},{"id":1068,"kind":2048,"name":"toString","url":"classes/buffer.html#tostring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1069,"kind":2048,"name":"toJsonObject","url":"classes/buffer.html#tojsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1070,"kind":2048,"name":"toJsonArray","url":"classes/buffer.html#tojsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1071,"kind":2048,"name":"getByte","url":"classes/buffer.html#getbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1072,"kind":2048,"name":"getUnsignedByte","url":"classes/buffer.html#getunsignedbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1073,"kind":2048,"name":"getInt","url":"classes/buffer.html#getint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1074,"kind":2048,"name":"getIntLE","url":"classes/buffer.html#getintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1075,"kind":2048,"name":"getUnsignedInt","url":"classes/buffer.html#getunsignedint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1076,"kind":2048,"name":"getUnsignedIntLE","url":"classes/buffer.html#getunsignedintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1077,"kind":2048,"name":"getLong","url":"classes/buffer.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1078,"kind":2048,"name":"getLongLE","url":"classes/buffer.html#getlongle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1079,"kind":2048,"name":"getDouble","url":"classes/buffer.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1080,"kind":2048,"name":"getFloat","url":"classes/buffer.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1081,"kind":2048,"name":"getShort","url":"classes/buffer.html#getshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1082,"kind":2048,"name":"getShortLE","url":"classes/buffer.html#getshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1083,"kind":2048,"name":"getUnsignedShort","url":"classes/buffer.html#getunsignedshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1084,"kind":2048,"name":"getUnsignedShortLE","url":"classes/buffer.html#getunsignedshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1085,"kind":2048,"name":"getMedium","url":"classes/buffer.html#getmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1086,"kind":2048,"name":"getMediumLE","url":"classes/buffer.html#getmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1087,"kind":2048,"name":"getUnsignedMedium","url":"classes/buffer.html#getunsignedmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1088,"kind":2048,"name":"getUnsignedMediumLE","url":"classes/buffer.html#getunsignedmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1089,"kind":2048,"name":"getBuffer","url":"classes/buffer.html#getbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1090,"kind":2048,"name":"getString","url":"classes/buffer.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1091,"kind":2048,"name":"appendBuffer","url":"classes/buffer.html#appendbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1092,"kind":2048,"name":"appendByte","url":"classes/buffer.html#appendbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1093,"kind":2048,"name":"appendUnsignedByte","url":"classes/buffer.html#appendunsignedbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1094,"kind":2048,"name":"appendInt","url":"classes/buffer.html#appendint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1095,"kind":2048,"name":"appendIntLE","url":"classes/buffer.html#appendintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1096,"kind":2048,"name":"appendUnsignedInt","url":"classes/buffer.html#appendunsignedint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1097,"kind":2048,"name":"appendUnsignedIntLE","url":"classes/buffer.html#appendunsignedintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1098,"kind":2048,"name":"appendMedium","url":"classes/buffer.html#appendmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1099,"kind":2048,"name":"appendMediumLE","url":"classes/buffer.html#appendmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1100,"kind":2048,"name":"appendLong","url":"classes/buffer.html#appendlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1101,"kind":2048,"name":"appendLongLE","url":"classes/buffer.html#appendlongle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1102,"kind":2048,"name":"appendShort","url":"classes/buffer.html#appendshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1103,"kind":2048,"name":"appendShortLE","url":"classes/buffer.html#appendshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1104,"kind":2048,"name":"appendUnsignedShort","url":"classes/buffer.html#appendunsignedshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1105,"kind":2048,"name":"appendUnsignedShortLE","url":"classes/buffer.html#appendunsignedshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1106,"kind":2048,"name":"appendFloat","url":"classes/buffer.html#appendfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1107,"kind":2048,"name":"appendDouble","url":"classes/buffer.html#appenddouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1108,"kind":2048,"name":"appendString","url":"classes/buffer.html#appendstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1109,"kind":2048,"name":"setByte","url":"classes/buffer.html#setbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1110,"kind":2048,"name":"setUnsignedByte","url":"classes/buffer.html#setunsignedbyte","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1111,"kind":2048,"name":"setInt","url":"classes/buffer.html#setint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1112,"kind":2048,"name":"setIntLE","url":"classes/buffer.html#setintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1113,"kind":2048,"name":"setUnsignedInt","url":"classes/buffer.html#setunsignedint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1114,"kind":2048,"name":"setUnsignedIntLE","url":"classes/buffer.html#setunsignedintle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1115,"kind":2048,"name":"setMedium","url":"classes/buffer.html#setmedium","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1116,"kind":2048,"name":"setMediumLE","url":"classes/buffer.html#setmediumle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1117,"kind":2048,"name":"setLong","url":"classes/buffer.html#setlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1118,"kind":2048,"name":"setLongLE","url":"classes/buffer.html#setlongle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1119,"kind":2048,"name":"setDouble","url":"classes/buffer.html#setdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1120,"kind":2048,"name":"setFloat","url":"classes/buffer.html#setfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1121,"kind":2048,"name":"setShort","url":"classes/buffer.html#setshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1122,"kind":2048,"name":"setShortLE","url":"classes/buffer.html#setshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1123,"kind":2048,"name":"setUnsignedShort","url":"classes/buffer.html#setunsignedshort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1124,"kind":2048,"name":"setUnsignedShortLE","url":"classes/buffer.html#setunsignedshortle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1125,"kind":2048,"name":"setBuffer","url":"classes/buffer.html#setbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1126,"kind":2048,"name":"setString","url":"classes/buffer.html#setstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1127,"kind":2048,"name":"length","url":"classes/buffer.html#length","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1128,"kind":2048,"name":"copy","url":"classes/buffer.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1129,"kind":2048,"name":"slice","url":"classes/buffer.html#slice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Buffer"},{"id":1130,"kind":128,"name":"CLI","url":"classes/cli.html","classes":"tsd-kind-class"},{"id":1131,"kind":2048,"name":"create","url":"classes/cli.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CLI"},{"id":1132,"kind":2048,"name":"parse","url":"classes/cli.html#parse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1133,"kind":2048,"name":"getName","url":"classes/cli.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1134,"kind":2048,"name":"setName","url":"classes/cli.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1135,"kind":2048,"name":"getDescription","url":"classes/cli.html#getdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1136,"kind":2048,"name":"setDescription","url":"classes/cli.html#setdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1137,"kind":2048,"name":"getSummary","url":"classes/cli.html#getsummary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1138,"kind":2048,"name":"setSummary","url":"classes/cli.html#setsummary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1139,"kind":2048,"name":"isHidden","url":"classes/cli.html#ishidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1140,"kind":2048,"name":"setHidden","url":"classes/cli.html#sethidden","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1141,"kind":2048,"name":"getOptions","url":"classes/cli.html#getoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1142,"kind":2048,"name":"addOption","url":"classes/cli.html#addoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1143,"kind":2048,"name":"addOptions","url":"classes/cli.html#addoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1144,"kind":2048,"name":"setOptions","url":"classes/cli.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1145,"kind":2048,"name":"getArguments","url":"classes/cli.html#getarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1146,"kind":2048,"name":"addArgument","url":"classes/cli.html#addargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1147,"kind":2048,"name":"addArguments","url":"classes/cli.html#addarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1148,"kind":2048,"name":"setArguments","url":"classes/cli.html#setarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1149,"kind":2048,"name":"getOption","url":"classes/cli.html#getoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1150,"kind":2048,"name":"getArgument","url":"classes/cli.html#getargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1151,"kind":2048,"name":"removeOption","url":"classes/cli.html#removeoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1152,"kind":2048,"name":"removeArgument","url":"classes/cli.html#removeargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CLI"},{"id":1153,"kind":128,"name":"CommandLine","url":"classes/commandline.html","classes":"tsd-kind-class"},{"id":1154,"kind":2048,"name":"create","url":"classes/commandline.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandLine"},{"id":1155,"kind":2048,"name":"cli","url":"classes/commandline.html#cli","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1156,"kind":2048,"name":"allArguments","url":"classes/commandline.html#allarguments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1157,"kind":2048,"name":"getOptionValue","url":"classes/commandline.html#getoptionvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CommandLine"},{"id":1158,"kind":2048,"name":"getArgumentValue","url":"classes/commandline.html#getargumentvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CommandLine"},{"id":1159,"kind":2048,"name":"isFlagEnabled","url":"classes/commandline.html#isflagenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1160,"kind":2048,"name":"isOptionAssigned","url":"classes/commandline.html#isoptionassigned","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1161,"kind":2048,"name":"getRawValues","url":"classes/commandline.html#getrawvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1162,"kind":2048,"name":"getRawValuesForOption","url":"classes/commandline.html#getrawvaluesforoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1163,"kind":2048,"name":"getRawValuesForArgument","url":"classes/commandline.html#getrawvaluesforargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1164,"kind":2048,"name":"getRawValueForOption","url":"classes/commandline.html#getrawvalueforoption","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1165,"kind":2048,"name":"acceptMoreValues","url":"classes/commandline.html#acceptmorevalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1166,"kind":2048,"name":"getRawValueForArgument","url":"classes/commandline.html#getrawvalueforargument","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1167,"kind":2048,"name":"isArgumentAssigned","url":"classes/commandline.html#isargumentassigned","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1168,"kind":2048,"name":"isSeenInCommandLine","url":"classes/commandline.html#isseenincommandline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1169,"kind":2048,"name":"isValid","url":"classes/commandline.html#isvalid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1170,"kind":2048,"name":"isAskingForHelp","url":"classes/commandline.html#isaskingforhelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandLine"},{"id":1171,"kind":128,"name":"CompositeFuture","url":"classes/compositefuture.html","classes":"tsd-kind-class"},{"id":1172,"kind":2048,"name":"complete","url":"classes/compositefuture.html#complete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1173,"kind":2048,"name":"tryComplete","url":"classes/compositefuture.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1174,"kind":2048,"name":"result","url":"classes/compositefuture.html#result","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1175,"kind":2048,"name":"compose","url":"classes/compositefuture.html#compose","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite","parent":"CompositeFuture"},{"id":1176,"kind":2048,"name":"map","url":"classes/compositefuture.html#map","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite","parent":"CompositeFuture"},{"id":1177,"kind":2048,"name":"completer","url":"classes/compositefuture.html#completer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1178,"kind":2048,"name":"recover","url":"classes/compositefuture.html#recover","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1179,"kind":2048,"name":"otherwise","url":"classes/compositefuture.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1180,"kind":2048,"name":"otherwiseEmpty","url":"classes/compositefuture.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1181,"kind":2048,"name":"all","url":"classes/compositefuture.html#all","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"CompositeFuture"},{"id":1182,"kind":2048,"name":"any","url":"classes/compositefuture.html#any","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"CompositeFuture"},{"id":1183,"kind":2048,"name":"join","url":"classes/compositefuture.html#join","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"CompositeFuture"},{"id":1184,"kind":2048,"name":"setHandler","url":"classes/compositefuture.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1185,"kind":2048,"name":"cause","url":"classes/compositefuture.html#cause","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1186,"kind":2048,"name":"succeeded","url":"classes/compositefuture.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1187,"kind":2048,"name":"failed","url":"classes/compositefuture.html#failed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1188,"kind":2048,"name":"isComplete","url":"classes/compositefuture.html#iscomplete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CompositeFuture"},{"id":1189,"kind":2048,"name":"resultAt","url":"classes/compositefuture.html#resultat","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"CompositeFuture"},{"id":1190,"kind":2048,"name":"size","url":"classes/compositefuture.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CompositeFuture"},{"id":1191,"kind":2048,"name":"future","url":"classes/compositefuture.html#future","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static","parent":"CompositeFuture"},{"id":1192,"kind":2048,"name":"succeededFuture","url":"classes/compositefuture.html#succeededfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static","parent":"CompositeFuture"},{"id":1193,"kind":2048,"name":"failedFuture","url":"classes/compositefuture.html#failedfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static","parent":"CompositeFuture"},{"id":1194,"kind":2048,"name":"fail","url":"classes/compositefuture.html#fail","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CompositeFuture"},{"id":1195,"kind":2048,"name":"tryFail","url":"classes/compositefuture.html#tryfail","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CompositeFuture"},{"id":1196,"kind":2048,"name":"mapEmpty","url":"classes/compositefuture.html#mapempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"CompositeFuture"},{"id":1197,"kind":128,"name":"Context","url":"classes/context.html","classes":"tsd-kind-class"},{"id":1198,"kind":2048,"name":"isOnWorkerThread","url":"classes/context.html#isonworkerthread","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Context"},{"id":1199,"kind":2048,"name":"isOnEventLoopThread","url":"classes/context.html#isoneventloopthread","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Context"},{"id":1200,"kind":2048,"name":"isOnVertxThread","url":"classes/context.html#isonvertxthread","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Context"},{"id":1201,"kind":2048,"name":"runOnContext","url":"classes/context.html#runoncontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1202,"kind":2048,"name":"executeBlocking","url":"classes/context.html#executeblocking","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Context"},{"id":1203,"kind":2048,"name":"deploymentID","url":"classes/context.html#deploymentid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1204,"kind":2048,"name":"config","url":"classes/context.html#config","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1205,"kind":2048,"name":"processArgs","url":"classes/context.html#processargs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1206,"kind":2048,"name":"isEventLoopContext","url":"classes/context.html#iseventloopcontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1207,"kind":2048,"name":"isWorkerContext","url":"classes/context.html#isworkercontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1208,"kind":2048,"name":"isMultiThreadedWorkerContext","url":"classes/context.html#ismultithreadedworkercontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1209,"kind":2048,"name":"get","url":"classes/context.html#get","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Context"},{"id":1210,"kind":2048,"name":"put","url":"classes/context.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1211,"kind":2048,"name":"remove","url":"classes/context.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1212,"kind":2048,"name":"owner","url":"classes/context.html#owner","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1213,"kind":2048,"name":"getInstanceCount","url":"classes/context.html#getinstancecount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1214,"kind":2048,"name":"exceptionHandler","url":"classes/context.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Context"},{"id":1215,"kind":128,"name":"Counter","url":"classes/counter.html","classes":"tsd-kind-class"},{"id":1216,"kind":2048,"name":"get","url":"classes/counter.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1217,"kind":2048,"name":"incrementAndGet","url":"classes/counter.html#incrementandget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1218,"kind":2048,"name":"getAndIncrement","url":"classes/counter.html#getandincrement","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1219,"kind":2048,"name":"decrementAndGet","url":"classes/counter.html#decrementandget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1220,"kind":2048,"name":"addAndGet","url":"classes/counter.html#addandget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1221,"kind":2048,"name":"getAndAdd","url":"classes/counter.html#getandadd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1222,"kind":2048,"name":"compareAndSet","url":"classes/counter.html#compareandset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Counter"},{"id":1223,"kind":128,"name":"DatagramPacket","url":"classes/datagrampacket.html","classes":"tsd-kind-class"},{"id":1224,"kind":2048,"name":"sender","url":"classes/datagrampacket.html#sender","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramPacket"},{"id":1225,"kind":2048,"name":"data","url":"classes/datagrampacket.html#data","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramPacket"},{"id":1226,"kind":128,"name":"DatagramSocket","url":"classes/datagramsocket.html","classes":"tsd-kind-class"},{"id":1227,"kind":2048,"name":"isMetricsEnabled","url":"classes/datagramsocket.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1228,"kind":2048,"name":"send","url":"classes/datagramsocket.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1229,"kind":2048,"name":"sender","url":"classes/datagramsocket.html#sender","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1230,"kind":2048,"name":"close","url":"classes/datagramsocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1231,"kind":2048,"name":"localAddress","url":"classes/datagramsocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1232,"kind":2048,"name":"listenMulticastGroup","url":"classes/datagramsocket.html#listenmulticastgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1233,"kind":2048,"name":"unlistenMulticastGroup","url":"classes/datagramsocket.html#unlistenmulticastgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1234,"kind":2048,"name":"blockMulticastGroup","url":"classes/datagramsocket.html#blockmulticastgroup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1235,"kind":2048,"name":"listen","url":"classes/datagramsocket.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1236,"kind":2048,"name":"pause","url":"classes/datagramsocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1237,"kind":2048,"name":"resume","url":"classes/datagramsocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1238,"kind":2048,"name":"fetch","url":"classes/datagramsocket.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1239,"kind":2048,"name":"endHandler","url":"classes/datagramsocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1240,"kind":2048,"name":"handler","url":"classes/datagramsocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1241,"kind":2048,"name":"exceptionHandler","url":"classes/datagramsocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DatagramSocket"},{"id":1242,"kind":128,"name":"DeliveryContext","url":"classes/deliverycontext.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1243,"kind":2048,"name":"message","url":"classes/deliverycontext.html#message","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryContext"},{"id":1244,"kind":2048,"name":"next","url":"classes/deliverycontext.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryContext"},{"id":1245,"kind":2048,"name":"send","url":"classes/deliverycontext.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryContext"},{"id":1246,"kind":2048,"name":"body","url":"classes/deliverycontext.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DeliveryContext"},{"id":1247,"kind":128,"name":"DnsClient","url":"classes/dnsclient.html","classes":"tsd-kind-class"},{"id":1248,"kind":2048,"name":"lookup","url":"classes/dnsclient.html#lookup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1249,"kind":2048,"name":"lookup4","url":"classes/dnsclient.html#lookup4","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1250,"kind":2048,"name":"lookup6","url":"classes/dnsclient.html#lookup6","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1251,"kind":2048,"name":"resolveA","url":"classes/dnsclient.html#resolvea","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1252,"kind":2048,"name":"resolveAAAA","url":"classes/dnsclient.html#resolveaaaa","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1253,"kind":2048,"name":"resolveCNAME","url":"classes/dnsclient.html#resolvecname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1254,"kind":2048,"name":"resolveMX","url":"classes/dnsclient.html#resolvemx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1255,"kind":2048,"name":"resolveTXT","url":"classes/dnsclient.html#resolvetxt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1256,"kind":2048,"name":"resolvePTR","url":"classes/dnsclient.html#resolveptr","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1257,"kind":2048,"name":"resolveNS","url":"classes/dnsclient.html#resolvens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1258,"kind":2048,"name":"resolveSRV","url":"classes/dnsclient.html#resolvesrv","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1259,"kind":2048,"name":"reverseLookup","url":"classes/dnsclient.html#reverselookup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DnsClient"},{"id":1260,"kind":128,"name":"EventBus","url":"classes/eventbus.html","classes":"tsd-kind-class"},{"id":1261,"kind":2048,"name":"isMetricsEnabled","url":"classes/eventbus.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":1262,"kind":2048,"name":"send","url":"classes/eventbus.html#send","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1263,"kind":2048,"name":"publish","url":"classes/eventbus.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBus"},{"id":1264,"kind":2048,"name":"consumer","url":"classes/eventbus.html#consumer","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1265,"kind":2048,"name":"localConsumer","url":"classes/eventbus.html#localconsumer","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1266,"kind":2048,"name":"sender","url":"classes/eventbus.html#sender","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1267,"kind":2048,"name":"publisher","url":"classes/eventbus.html#publisher","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1268,"kind":2048,"name":"addOutboundInterceptor","url":"classes/eventbus.html#addoutboundinterceptor","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1269,"kind":2048,"name":"removeOutboundInterceptor","url":"classes/eventbus.html#removeoutboundinterceptor","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1270,"kind":2048,"name":"addInboundInterceptor","url":"classes/eventbus.html#addinboundinterceptor","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1271,"kind":2048,"name":"removeInboundInterceptor","url":"classes/eventbus.html#removeinboundinterceptor","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"EventBus"},{"id":1272,"kind":128,"name":"FileProps","url":"classes/fileprops.html","classes":"tsd-kind-class"},{"id":1273,"kind":2048,"name":"creationTime","url":"classes/fileprops.html#creationtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1274,"kind":2048,"name":"lastAccessTime","url":"classes/fileprops.html#lastaccesstime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1275,"kind":2048,"name":"lastModifiedTime","url":"classes/fileprops.html#lastmodifiedtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1276,"kind":2048,"name":"isDirectory","url":"classes/fileprops.html#isdirectory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1277,"kind":2048,"name":"isOther","url":"classes/fileprops.html#isother","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1278,"kind":2048,"name":"isRegularFile","url":"classes/fileprops.html#isregularfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1279,"kind":2048,"name":"isSymbolicLink","url":"classes/fileprops.html#issymboliclink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1280,"kind":2048,"name":"size","url":"classes/fileprops.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileProps"},{"id":1281,"kind":128,"name":"FileSystem","url":"classes/filesystem.html","classes":"tsd-kind-class"},{"id":1282,"kind":2048,"name":"copy","url":"classes/filesystem.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1283,"kind":2048,"name":"copyBlocking","url":"classes/filesystem.html#copyblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1284,"kind":2048,"name":"copyRecursive","url":"classes/filesystem.html#copyrecursive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1285,"kind":2048,"name":"copyRecursiveBlocking","url":"classes/filesystem.html#copyrecursiveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1286,"kind":2048,"name":"move","url":"classes/filesystem.html#move","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1287,"kind":2048,"name":"moveBlocking","url":"classes/filesystem.html#moveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1288,"kind":2048,"name":"truncate","url":"classes/filesystem.html#truncate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1289,"kind":2048,"name":"truncateBlocking","url":"classes/filesystem.html#truncateblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1290,"kind":2048,"name":"chmod","url":"classes/filesystem.html#chmod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1291,"kind":2048,"name":"chmodBlocking","url":"classes/filesystem.html#chmodblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1292,"kind":2048,"name":"chmodRecursive","url":"classes/filesystem.html#chmodrecursive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1293,"kind":2048,"name":"chmodRecursiveBlocking","url":"classes/filesystem.html#chmodrecursiveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1294,"kind":2048,"name":"chown","url":"classes/filesystem.html#chown","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1295,"kind":2048,"name":"chownBlocking","url":"classes/filesystem.html#chownblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1296,"kind":2048,"name":"props","url":"classes/filesystem.html#props","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1297,"kind":2048,"name":"propsBlocking","url":"classes/filesystem.html#propsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1298,"kind":2048,"name":"lprops","url":"classes/filesystem.html#lprops","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1299,"kind":2048,"name":"lpropsBlocking","url":"classes/filesystem.html#lpropsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1300,"kind":2048,"name":"link","url":"classes/filesystem.html#link","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1301,"kind":2048,"name":"linkBlocking","url":"classes/filesystem.html#linkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1302,"kind":2048,"name":"symlink","url":"classes/filesystem.html#symlink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1303,"kind":2048,"name":"symlinkBlocking","url":"classes/filesystem.html#symlinkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1304,"kind":2048,"name":"unlink","url":"classes/filesystem.html#unlink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1305,"kind":2048,"name":"unlinkBlocking","url":"classes/filesystem.html#unlinkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1306,"kind":2048,"name":"readSymlink","url":"classes/filesystem.html#readsymlink","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1307,"kind":2048,"name":"readSymlinkBlocking","url":"classes/filesystem.html#readsymlinkblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1308,"kind":2048,"name":"delete","url":"classes/filesystem.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1309,"kind":2048,"name":"deleteBlocking","url":"classes/filesystem.html#deleteblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1310,"kind":2048,"name":"deleteRecursive","url":"classes/filesystem.html#deleterecursive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1311,"kind":2048,"name":"deleteRecursiveBlocking","url":"classes/filesystem.html#deleterecursiveblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1312,"kind":2048,"name":"mkdir","url":"classes/filesystem.html#mkdir","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1313,"kind":2048,"name":"mkdirBlocking","url":"classes/filesystem.html#mkdirblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1314,"kind":2048,"name":"mkdirs","url":"classes/filesystem.html#mkdirs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1315,"kind":2048,"name":"mkdirsBlocking","url":"classes/filesystem.html#mkdirsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1316,"kind":2048,"name":"readDir","url":"classes/filesystem.html#readdir","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1317,"kind":2048,"name":"readDirBlocking","url":"classes/filesystem.html#readdirblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1318,"kind":2048,"name":"readFile","url":"classes/filesystem.html#readfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1319,"kind":2048,"name":"readFileBlocking","url":"classes/filesystem.html#readfileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1320,"kind":2048,"name":"writeFile","url":"classes/filesystem.html#writefile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1321,"kind":2048,"name":"writeFileBlocking","url":"classes/filesystem.html#writefileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1322,"kind":2048,"name":"open","url":"classes/filesystem.html#open","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1323,"kind":2048,"name":"openBlocking","url":"classes/filesystem.html#openblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1324,"kind":2048,"name":"createFile","url":"classes/filesystem.html#createfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1325,"kind":2048,"name":"createFileBlocking","url":"classes/filesystem.html#createfileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1326,"kind":2048,"name":"exists","url":"classes/filesystem.html#exists","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1327,"kind":2048,"name":"existsBlocking","url":"classes/filesystem.html#existsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1328,"kind":2048,"name":"fsProps","url":"classes/filesystem.html#fsprops","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1329,"kind":2048,"name":"fsPropsBlocking","url":"classes/filesystem.html#fspropsblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1330,"kind":2048,"name":"createTempDirectory","url":"classes/filesystem.html#createtempdirectory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1331,"kind":2048,"name":"createTempDirectoryBlocking","url":"classes/filesystem.html#createtempdirectoryblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1332,"kind":2048,"name":"createTempFile","url":"classes/filesystem.html#createtempfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1333,"kind":2048,"name":"createTempFileBlocking","url":"classes/filesystem.html#createtempfileblocking","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystem"},{"id":1334,"kind":128,"name":"FileSystemProps","url":"classes/filesystemprops.html","classes":"tsd-kind-class"},{"id":1335,"kind":2048,"name":"totalSpace","url":"classes/filesystemprops.html#totalspace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemProps"},{"id":1336,"kind":2048,"name":"unallocatedSpace","url":"classes/filesystemprops.html#unallocatedspace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemProps"},{"id":1337,"kind":2048,"name":"usableSpace","url":"classes/filesystemprops.html#usablespace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FileSystemProps"},{"id":1338,"kind":128,"name":"Future","url":"classes/future.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1339,"kind":2048,"name":"future","url":"classes/future.html#future-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"Future"},{"id":1340,"kind":2048,"name":"succeededFuture","url":"classes/future.html#succeededfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"Future"},{"id":1341,"kind":2048,"name":"failedFuture","url":"classes/future.html#failedfuture","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"Future"},{"id":1342,"kind":2048,"name":"isComplete","url":"classes/future.html#iscomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1343,"kind":2048,"name":"setHandler","url":"classes/future.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1344,"kind":2048,"name":"complete","url":"classes/future.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1345,"kind":2048,"name":"fail","url":"classes/future.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1346,"kind":2048,"name":"tryComplete","url":"classes/future.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1347,"kind":2048,"name":"tryFail","url":"classes/future.html#tryfail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1348,"kind":2048,"name":"result","url":"classes/future.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1349,"kind":2048,"name":"cause","url":"classes/future.html#cause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1350,"kind":2048,"name":"succeeded","url":"classes/future.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1351,"kind":2048,"name":"failed","url":"classes/future.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1352,"kind":2048,"name":"compose","url":"classes/future.html#compose","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Future"},{"id":1353,"kind":2048,"name":"map","url":"classes/future.html#map","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Future"},{"id":1354,"kind":2048,"name":"mapEmpty","url":"classes/future.html#mapempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Future"},{"id":1355,"kind":2048,"name":"completer","url":"classes/future.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1356,"kind":2048,"name":"recover","url":"classes/future.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1357,"kind":2048,"name":"otherwise","url":"classes/future.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1358,"kind":2048,"name":"otherwiseEmpty","url":"classes/future.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Future"},{"id":1359,"kind":128,"name":"HttpClient","url":"classes/httpclient.html","classes":"tsd-kind-class"},{"id":1360,"kind":2048,"name":"isMetricsEnabled","url":"classes/httpclient.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1361,"kind":2048,"name":"request","url":"classes/httpclient.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1362,"kind":2048,"name":"requestAbs","url":"classes/httpclient.html#requestabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1363,"kind":2048,"name":"get","url":"classes/httpclient.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1364,"kind":2048,"name":"getAbs","url":"classes/httpclient.html#getabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1365,"kind":2048,"name":"getNow","url":"classes/httpclient.html#getnow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1366,"kind":2048,"name":"post","url":"classes/httpclient.html#post","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1367,"kind":2048,"name":"postAbs","url":"classes/httpclient.html#postabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1368,"kind":2048,"name":"head","url":"classes/httpclient.html#head","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1369,"kind":2048,"name":"headAbs","url":"classes/httpclient.html#headabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1370,"kind":2048,"name":"headNow","url":"classes/httpclient.html#headnow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1371,"kind":2048,"name":"options","url":"classes/httpclient.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1372,"kind":2048,"name":"optionsAbs","url":"classes/httpclient.html#optionsabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1373,"kind":2048,"name":"optionsNow","url":"classes/httpclient.html#optionsnow","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1374,"kind":2048,"name":"put","url":"classes/httpclient.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1375,"kind":2048,"name":"putAbs","url":"classes/httpclient.html#putabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1376,"kind":2048,"name":"delete","url":"classes/httpclient.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1377,"kind":2048,"name":"deleteAbs","url":"classes/httpclient.html#deleteabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1378,"kind":2048,"name":"websocket","url":"classes/httpclient.html#websocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1379,"kind":2048,"name":"websocketAbs","url":"classes/httpclient.html#websocketabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1380,"kind":2048,"name":"websocketStream","url":"classes/httpclient.html#websocketstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1381,"kind":2048,"name":"websocketStreamAbs","url":"classes/httpclient.html#websocketstreamabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1382,"kind":2048,"name":"connectionHandler","url":"classes/httpclient.html#connectionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1383,"kind":2048,"name":"redirectHandler","url":"classes/httpclient.html#redirecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1384,"kind":2048,"name":"close","url":"classes/httpclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClient"},{"id":1385,"kind":128,"name":"HttpClientRequest","url":"classes/httpclientrequest.html","classes":"tsd-kind-class"},{"id":1386,"kind":2048,"name":"writeQueueFull","url":"classes/httpclientrequest.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1387,"kind":2048,"name":"exceptionHandler","url":"classes/httpclientrequest.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1388,"kind":2048,"name":"write","url":"classes/httpclientrequest.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1389,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/httpclientrequest.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1390,"kind":2048,"name":"drainHandler","url":"classes/httpclientrequest.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1391,"kind":2048,"name":"handler","url":"classes/httpclientrequest.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1392,"kind":2048,"name":"pause","url":"classes/httpclientrequest.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1393,"kind":2048,"name":"resume","url":"classes/httpclientrequest.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1394,"kind":2048,"name":"fetch","url":"classes/httpclientrequest.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1395,"kind":2048,"name":"endHandler","url":"classes/httpclientrequest.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1396,"kind":2048,"name":"setFollowRedirects","url":"classes/httpclientrequest.html#setfollowredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1397,"kind":2048,"name":"setChunked","url":"classes/httpclientrequest.html#setchunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1398,"kind":2048,"name":"isChunked","url":"classes/httpclientrequest.html#ischunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1399,"kind":2048,"name":"method","url":"classes/httpclientrequest.html#method","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1400,"kind":2048,"name":"getRawMethod","url":"classes/httpclientrequest.html#getrawmethod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1401,"kind":2048,"name":"setRawMethod","url":"classes/httpclientrequest.html#setrawmethod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1402,"kind":2048,"name":"absoluteURI","url":"classes/httpclientrequest.html#absoluteuri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1403,"kind":2048,"name":"uri","url":"classes/httpclientrequest.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1404,"kind":2048,"name":"path","url":"classes/httpclientrequest.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1405,"kind":2048,"name":"query","url":"classes/httpclientrequest.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1406,"kind":2048,"name":"setHost","url":"classes/httpclientrequest.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1407,"kind":2048,"name":"getHost","url":"classes/httpclientrequest.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1408,"kind":2048,"name":"headers","url":"classes/httpclientrequest.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1409,"kind":2048,"name":"putHeader","url":"classes/httpclientrequest.html#putheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1410,"kind":2048,"name":"continueHandler","url":"classes/httpclientrequest.html#continuehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1411,"kind":2048,"name":"sendHead","url":"classes/httpclientrequest.html#sendhead","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1412,"kind":2048,"name":"end","url":"classes/httpclientrequest.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1413,"kind":2048,"name":"setTimeout","url":"classes/httpclientrequest.html#settimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1414,"kind":2048,"name":"pushHandler","url":"classes/httpclientrequest.html#pushhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1415,"kind":2048,"name":"reset","url":"classes/httpclientrequest.html#reset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1416,"kind":2048,"name":"connection","url":"classes/httpclientrequest.html#connection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1417,"kind":2048,"name":"connectionHandler","url":"classes/httpclientrequest.html#connectionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1418,"kind":2048,"name":"writeCustomFrame","url":"classes/httpclientrequest.html#writecustomframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1419,"kind":2048,"name":"streamId","url":"classes/httpclientrequest.html#streamid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1420,"kind":2048,"name":"setStreamPriority","url":"classes/httpclientrequest.html#setstreampriority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1421,"kind":2048,"name":"getStreamPriority","url":"classes/httpclientrequest.html#getstreampriority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientRequest"},{"id":1422,"kind":128,"name":"HttpClientResponse","url":"classes/httpclientresponse.html","classes":"tsd-kind-class"},{"id":1423,"kind":2048,"name":"fetch","url":"classes/httpclientresponse.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1424,"kind":2048,"name":"resume","url":"classes/httpclientresponse.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1425,"kind":2048,"name":"exceptionHandler","url":"classes/httpclientresponse.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1426,"kind":2048,"name":"handler","url":"classes/httpclientresponse.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1427,"kind":2048,"name":"pause","url":"classes/httpclientresponse.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1428,"kind":2048,"name":"endHandler","url":"classes/httpclientresponse.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1429,"kind":2048,"name":"version","url":"classes/httpclientresponse.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1430,"kind":2048,"name":"statusCode","url":"classes/httpclientresponse.html#statuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1431,"kind":2048,"name":"statusMessage","url":"classes/httpclientresponse.html#statusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1432,"kind":2048,"name":"headers","url":"classes/httpclientresponse.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1433,"kind":2048,"name":"getHeader","url":"classes/httpclientresponse.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1434,"kind":2048,"name":"getTrailer","url":"classes/httpclientresponse.html#gettrailer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1435,"kind":2048,"name":"trailers","url":"classes/httpclientresponse.html#trailers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1436,"kind":2048,"name":"cookies","url":"classes/httpclientresponse.html#cookies","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1437,"kind":2048,"name":"bodyHandler","url":"classes/httpclientresponse.html#bodyhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1438,"kind":2048,"name":"customFrameHandler","url":"classes/httpclientresponse.html#customframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1439,"kind":2048,"name":"netSocket","url":"classes/httpclientresponse.html#netsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1440,"kind":2048,"name":"request","url":"classes/httpclientresponse.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1441,"kind":2048,"name":"streamPriorityHandler","url":"classes/httpclientresponse.html#streampriorityhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpClientResponse"},{"id":1442,"kind":128,"name":"HttpConnection","url":"classes/httpconnection.html","classes":"tsd-kind-class"},{"id":1443,"kind":2048,"name":"getWindowSize","url":"classes/httpconnection.html#getwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1444,"kind":2048,"name":"setWindowSize","url":"classes/httpconnection.html#setwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1445,"kind":2048,"name":"goAway","url":"classes/httpconnection.html#goaway","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1446,"kind":2048,"name":"goAwayHandler","url":"classes/httpconnection.html#goawayhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1447,"kind":2048,"name":"shutdownHandler","url":"classes/httpconnection.html#shutdownhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1448,"kind":2048,"name":"shutdown","url":"classes/httpconnection.html#shutdown","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1449,"kind":2048,"name":"closeHandler","url":"classes/httpconnection.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1450,"kind":2048,"name":"close","url":"classes/httpconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1451,"kind":2048,"name":"settings","url":"classes/httpconnection.html#settings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1452,"kind":2048,"name":"updateSettings","url":"classes/httpconnection.html#updatesettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1453,"kind":2048,"name":"remoteSettings","url":"classes/httpconnection.html#remotesettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1454,"kind":2048,"name":"remoteSettingsHandler","url":"classes/httpconnection.html#remotesettingshandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1455,"kind":2048,"name":"ping","url":"classes/httpconnection.html#ping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1456,"kind":2048,"name":"pingHandler","url":"classes/httpconnection.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1457,"kind":2048,"name":"exceptionHandler","url":"classes/httpconnection.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1458,"kind":2048,"name":"remoteAddress","url":"classes/httpconnection.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1459,"kind":2048,"name":"localAddress","url":"classes/httpconnection.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1460,"kind":2048,"name":"isSsl","url":"classes/httpconnection.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1461,"kind":2048,"name":"indicatedServerName","url":"classes/httpconnection.html#indicatedservername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpConnection"},{"id":1462,"kind":128,"name":"HttpFrame","url":"classes/httpframe.html","classes":"tsd-kind-class"},{"id":1463,"kind":2048,"name":"type","url":"classes/httpframe.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpFrame"},{"id":1464,"kind":2048,"name":"flags","url":"classes/httpframe.html#flags","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpFrame"},{"id":1465,"kind":2048,"name":"payload","url":"classes/httpframe.html#payload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpFrame"},{"id":1466,"kind":128,"name":"HttpServer","url":"classes/httpserver.html","classes":"tsd-kind-class"},{"id":1467,"kind":2048,"name":"isMetricsEnabled","url":"classes/httpserver.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1468,"kind":2048,"name":"requestStream","url":"classes/httpserver.html#requeststream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1469,"kind":2048,"name":"requestHandler","url":"classes/httpserver.html#requesthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1470,"kind":2048,"name":"connectionHandler","url":"classes/httpserver.html#connectionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1471,"kind":2048,"name":"exceptionHandler","url":"classes/httpserver.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1472,"kind":2048,"name":"websocketStream","url":"classes/httpserver.html#websocketstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1473,"kind":2048,"name":"websocketHandler","url":"classes/httpserver.html#websockethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1474,"kind":2048,"name":"listen","url":"classes/httpserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1475,"kind":2048,"name":"close","url":"classes/httpserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1476,"kind":2048,"name":"actualPort","url":"classes/httpserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServer"},{"id":1477,"kind":128,"name":"HttpServerFileUpload","url":"classes/httpserverfileupload.html","classes":"tsd-kind-class"},{"id":1478,"kind":2048,"name":"exceptionHandler","url":"classes/httpserverfileupload.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1479,"kind":2048,"name":"handler","url":"classes/httpserverfileupload.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1480,"kind":2048,"name":"endHandler","url":"classes/httpserverfileupload.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1481,"kind":2048,"name":"pause","url":"classes/httpserverfileupload.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1482,"kind":2048,"name":"resume","url":"classes/httpserverfileupload.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1483,"kind":2048,"name":"fetch","url":"classes/httpserverfileupload.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1484,"kind":2048,"name":"streamToFileSystem","url":"classes/httpserverfileupload.html#streamtofilesystem","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1485,"kind":2048,"name":"filename","url":"classes/httpserverfileupload.html#filename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1486,"kind":2048,"name":"name","url":"classes/httpserverfileupload.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1487,"kind":2048,"name":"contentType","url":"classes/httpserverfileupload.html#contenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1488,"kind":2048,"name":"contentTransferEncoding","url":"classes/httpserverfileupload.html#contenttransferencoding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1489,"kind":2048,"name":"charset","url":"classes/httpserverfileupload.html#charset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1490,"kind":2048,"name":"size","url":"classes/httpserverfileupload.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1491,"kind":2048,"name":"isSizeAvailable","url":"classes/httpserverfileupload.html#issizeavailable","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerFileUpload"},{"id":1492,"kind":128,"name":"HttpServerRequest","url":"classes/httpserverrequest.html","classes":"tsd-kind-class"},{"id":1493,"kind":2048,"name":"exceptionHandler","url":"classes/httpserverrequest.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1494,"kind":2048,"name":"handler","url":"classes/httpserverrequest.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1495,"kind":2048,"name":"pause","url":"classes/httpserverrequest.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1496,"kind":2048,"name":"resume","url":"classes/httpserverrequest.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1497,"kind":2048,"name":"fetch","url":"classes/httpserverrequest.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1498,"kind":2048,"name":"endHandler","url":"classes/httpserverrequest.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1499,"kind":2048,"name":"version","url":"classes/httpserverrequest.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1500,"kind":2048,"name":"method","url":"classes/httpserverrequest.html#method","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1501,"kind":2048,"name":"rawMethod","url":"classes/httpserverrequest.html#rawmethod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1502,"kind":2048,"name":"isSSL","url":"classes/httpserverrequest.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1503,"kind":2048,"name":"scheme","url":"classes/httpserverrequest.html#scheme","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1504,"kind":2048,"name":"uri","url":"classes/httpserverrequest.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1505,"kind":2048,"name":"path","url":"classes/httpserverrequest.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1506,"kind":2048,"name":"query","url":"classes/httpserverrequest.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1507,"kind":2048,"name":"host","url":"classes/httpserverrequest.html#host","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1508,"kind":2048,"name":"bytesRead","url":"classes/httpserverrequest.html#bytesread","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1509,"kind":2048,"name":"response","url":"classes/httpserverrequest.html#response","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1510,"kind":2048,"name":"headers","url":"classes/httpserverrequest.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1511,"kind":2048,"name":"getHeader","url":"classes/httpserverrequest.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1512,"kind":2048,"name":"params","url":"classes/httpserverrequest.html#params","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1513,"kind":2048,"name":"getParam","url":"classes/httpserverrequest.html#getparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1514,"kind":2048,"name":"remoteAddress","url":"classes/httpserverrequest.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1515,"kind":2048,"name":"localAddress","url":"classes/httpserverrequest.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1516,"kind":2048,"name":"absoluteURI","url":"classes/httpserverrequest.html#absoluteuri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1517,"kind":2048,"name":"bodyHandler","url":"classes/httpserverrequest.html#bodyhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1518,"kind":2048,"name":"netSocket","url":"classes/httpserverrequest.html#netsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1519,"kind":2048,"name":"setExpectMultipart","url":"classes/httpserverrequest.html#setexpectmultipart","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1520,"kind":2048,"name":"isExpectMultipart","url":"classes/httpserverrequest.html#isexpectmultipart","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1521,"kind":2048,"name":"uploadHandler","url":"classes/httpserverrequest.html#uploadhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1522,"kind":2048,"name":"formAttributes","url":"classes/httpserverrequest.html#formattributes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1523,"kind":2048,"name":"getFormAttribute","url":"classes/httpserverrequest.html#getformattribute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1524,"kind":2048,"name":"upgrade","url":"classes/httpserverrequest.html#upgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1525,"kind":2048,"name":"isEnded","url":"classes/httpserverrequest.html#isended","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1526,"kind":2048,"name":"customFrameHandler","url":"classes/httpserverrequest.html#customframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1527,"kind":2048,"name":"connection","url":"classes/httpserverrequest.html#connection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1528,"kind":2048,"name":"streamPriority","url":"classes/httpserverrequest.html#streampriority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1529,"kind":2048,"name":"streamPriorityHandler","url":"classes/httpserverrequest.html#streampriorityhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerRequest"},{"id":1530,"kind":128,"name":"HttpServerResponse","url":"classes/httpserverresponse.html","classes":"tsd-kind-class"},{"id":1531,"kind":2048,"name":"writeQueueFull","url":"classes/httpserverresponse.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1532,"kind":2048,"name":"exceptionHandler","url":"classes/httpserverresponse.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1533,"kind":2048,"name":"write","url":"classes/httpserverresponse.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1534,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/httpserverresponse.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1535,"kind":2048,"name":"drainHandler","url":"classes/httpserverresponse.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1536,"kind":2048,"name":"getStatusCode","url":"classes/httpserverresponse.html#getstatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1537,"kind":2048,"name":"setStatusCode","url":"classes/httpserverresponse.html#setstatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1538,"kind":2048,"name":"getStatusMessage","url":"classes/httpserverresponse.html#getstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1539,"kind":2048,"name":"setStatusMessage","url":"classes/httpserverresponse.html#setstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1540,"kind":2048,"name":"setChunked","url":"classes/httpserverresponse.html#setchunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1541,"kind":2048,"name":"isChunked","url":"classes/httpserverresponse.html#ischunked","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1542,"kind":2048,"name":"headers","url":"classes/httpserverresponse.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1543,"kind":2048,"name":"putHeader","url":"classes/httpserverresponse.html#putheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1544,"kind":2048,"name":"trailers","url":"classes/httpserverresponse.html#trailers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1545,"kind":2048,"name":"putTrailer","url":"classes/httpserverresponse.html#puttrailer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1546,"kind":2048,"name":"closeHandler","url":"classes/httpserverresponse.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1547,"kind":2048,"name":"endHandler","url":"classes/httpserverresponse.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1548,"kind":2048,"name":"writeContinue","url":"classes/httpserverresponse.html#writecontinue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1549,"kind":2048,"name":"end","url":"classes/httpserverresponse.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1550,"kind":2048,"name":"sendFile","url":"classes/httpserverresponse.html#sendfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1551,"kind":2048,"name":"close","url":"classes/httpserverresponse.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1552,"kind":2048,"name":"ended","url":"classes/httpserverresponse.html#ended","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1553,"kind":2048,"name":"closed","url":"classes/httpserverresponse.html#closed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1554,"kind":2048,"name":"headWritten","url":"classes/httpserverresponse.html#headwritten","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1555,"kind":2048,"name":"headersEndHandler","url":"classes/httpserverresponse.html#headersendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1556,"kind":2048,"name":"bodyEndHandler","url":"classes/httpserverresponse.html#bodyendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1557,"kind":2048,"name":"bytesWritten","url":"classes/httpserverresponse.html#byteswritten","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1558,"kind":2048,"name":"streamId","url":"classes/httpserverresponse.html#streamid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1559,"kind":2048,"name":"push","url":"classes/httpserverresponse.html#push","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1560,"kind":2048,"name":"reset","url":"classes/httpserverresponse.html#reset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1561,"kind":2048,"name":"writeCustomFrame","url":"classes/httpserverresponse.html#writecustomframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1562,"kind":2048,"name":"setStreamPriority","url":"classes/httpserverresponse.html#setstreampriority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpServerResponse"},{"id":1563,"kind":128,"name":"JsonEvent","url":"classes/jsonevent.html","classes":"tsd-kind-class"},{"id":1564,"kind":2048,"name":"type","url":"classes/jsonevent.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1565,"kind":2048,"name":"fieldName","url":"classes/jsonevent.html#fieldname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1566,"kind":2048,"name":"value","url":"classes/jsonevent.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1567,"kind":2048,"name":"isNumber","url":"classes/jsonevent.html#isnumber","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1568,"kind":2048,"name":"integerValue","url":"classes/jsonevent.html#integervalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1569,"kind":2048,"name":"longValue","url":"classes/jsonevent.html#longvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1570,"kind":2048,"name":"floatValue","url":"classes/jsonevent.html#floatvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1571,"kind":2048,"name":"doubleValue","url":"classes/jsonevent.html#doublevalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1572,"kind":2048,"name":"isBoolean","url":"classes/jsonevent.html#isboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1573,"kind":2048,"name":"booleanValue","url":"classes/jsonevent.html#booleanvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1574,"kind":2048,"name":"isString","url":"classes/jsonevent.html#isstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1575,"kind":2048,"name":"stringValue","url":"classes/jsonevent.html#stringvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1576,"kind":2048,"name":"binaryValue","url":"classes/jsonevent.html#binaryvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1577,"kind":2048,"name":"isNull","url":"classes/jsonevent.html#isnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1578,"kind":2048,"name":"isObject","url":"classes/jsonevent.html#isobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1579,"kind":2048,"name":"objectValue","url":"classes/jsonevent.html#objectvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1580,"kind":2048,"name":"isArray","url":"classes/jsonevent.html#isarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1581,"kind":2048,"name":"arrayValue","url":"classes/jsonevent.html#arrayvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonEvent"},{"id":1582,"kind":2048,"name":"mapTo","url":"classes/jsonevent.html#mapto","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"JsonEvent"},{"id":1583,"kind":128,"name":"JsonParser","url":"classes/jsonparser.html","classes":"tsd-kind-class"},{"id":1584,"kind":2048,"name":"handle","url":"classes/jsonparser.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1585,"kind":2048,"name":"newParser","url":"classes/jsonparser.html#newparser","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JsonParser"},{"id":1586,"kind":2048,"name":"write","url":"classes/jsonparser.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1587,"kind":2048,"name":"end","url":"classes/jsonparser.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1588,"kind":2048,"name":"objectEventMode","url":"classes/jsonparser.html#objecteventmode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1589,"kind":2048,"name":"objectValueMode","url":"classes/jsonparser.html#objectvaluemode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1590,"kind":2048,"name":"arrayEventMode","url":"classes/jsonparser.html#arrayeventmode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1591,"kind":2048,"name":"arrayValueMode","url":"classes/jsonparser.html#arrayvaluemode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1592,"kind":2048,"name":"pause","url":"classes/jsonparser.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1593,"kind":2048,"name":"resume","url":"classes/jsonparser.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1594,"kind":2048,"name":"fetch","url":"classes/jsonparser.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1595,"kind":2048,"name":"endHandler","url":"classes/jsonparser.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1596,"kind":2048,"name":"handler","url":"classes/jsonparser.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1597,"kind":2048,"name":"exceptionHandler","url":"classes/jsonparser.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JsonParser"},{"id":1598,"kind":128,"name":"LocalMap","url":"classes/localmap.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1599,"kind":2048,"name":"get","url":"classes/localmap.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1600,"kind":2048,"name":"put","url":"classes/localmap.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1601,"kind":2048,"name":"remove","url":"classes/localmap.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1602,"kind":2048,"name":"clear","url":"classes/localmap.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1603,"kind":2048,"name":"size","url":"classes/localmap.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1604,"kind":2048,"name":"isEmpty","url":"classes/localmap.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1605,"kind":2048,"name":"putIfAbsent","url":"classes/localmap.html#putifabsent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1606,"kind":2048,"name":"removeIfPresent","url":"classes/localmap.html#removeifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1607,"kind":2048,"name":"replaceIfPresent","url":"classes/localmap.html#replaceifpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1608,"kind":2048,"name":"replace","url":"classes/localmap.html#replace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1609,"kind":2048,"name":"close","url":"classes/localmap.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1610,"kind":2048,"name":"containsKey","url":"classes/localmap.html#containskey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1611,"kind":2048,"name":"containsValue","url":"classes/localmap.html#containsvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1612,"kind":2048,"name":"getOrDefault","url":"classes/localmap.html#getordefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"LocalMap"},{"id":1613,"kind":128,"name":"Lock","url":"classes/lock.html","classes":"tsd-kind-class"},{"id":1614,"kind":2048,"name":"release","url":"classes/lock.html#release","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Lock"},{"id":1615,"kind":256,"name":"Measured","url":"interfaces/measured.html","classes":"tsd-kind-interface"},{"id":1616,"kind":2048,"name":"isMetricsEnabled","url":"interfaces/measured.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Measured"},{"id":1617,"kind":128,"name":"Message","url":"classes/message.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1618,"kind":2048,"name":"address","url":"classes/message.html#address","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1619,"kind":2048,"name":"headers","url":"classes/message.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1620,"kind":2048,"name":"body","url":"classes/message.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1621,"kind":2048,"name":"replyAddress","url":"classes/message.html#replyaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1622,"kind":2048,"name":"isSend","url":"classes/message.html#issend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1623,"kind":2048,"name":"reply","url":"classes/message.html#reply","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Message"},{"id":1624,"kind":2048,"name":"fail","url":"classes/message.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Message"},{"id":1625,"kind":128,"name":"MessageConsumer","url":"classes/messageconsumer.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1626,"kind":2048,"name":"exceptionHandler","url":"classes/messageconsumer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1627,"kind":2048,"name":"handler","url":"classes/messageconsumer.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1628,"kind":2048,"name":"pause","url":"classes/messageconsumer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1629,"kind":2048,"name":"resume","url":"classes/messageconsumer.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1630,"kind":2048,"name":"fetch","url":"classes/messageconsumer.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1631,"kind":2048,"name":"endHandler","url":"classes/messageconsumer.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1632,"kind":2048,"name":"bodyStream","url":"classes/messageconsumer.html#bodystream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1633,"kind":2048,"name":"isRegistered","url":"classes/messageconsumer.html#isregistered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1634,"kind":2048,"name":"address","url":"classes/messageconsumer.html#address","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1635,"kind":2048,"name":"setMaxBufferedMessages","url":"classes/messageconsumer.html#setmaxbufferedmessages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1636,"kind":2048,"name":"getMaxBufferedMessages","url":"classes/messageconsumer.html#getmaxbufferedmessages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1637,"kind":2048,"name":"completionHandler","url":"classes/messageconsumer.html#completionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1638,"kind":2048,"name":"unregister","url":"classes/messageconsumer.html#unregister","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageConsumer"},{"id":1639,"kind":128,"name":"MessageProducer","url":"classes/messageproducer.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":1640,"kind":2048,"name":"end","url":"classes/messageproducer.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1641,"kind":2048,"name":"writeQueueFull","url":"classes/messageproducer.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1642,"kind":2048,"name":"send","url":"classes/messageproducer.html#send","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"MessageProducer"},{"id":1643,"kind":2048,"name":"exceptionHandler","url":"classes/messageproducer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1644,"kind":2048,"name":"write","url":"classes/messageproducer.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1645,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/messageproducer.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1646,"kind":2048,"name":"drainHandler","url":"classes/messageproducer.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1647,"kind":2048,"name":"deliveryOptions","url":"classes/messageproducer.html#deliveryoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1648,"kind":2048,"name":"address","url":"classes/messageproducer.html#address","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1649,"kind":2048,"name":"close","url":"classes/messageproducer.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MessageProducer"},{"id":1650,"kind":128,"name":"MultiMap","url":"classes/multimap.html","classes":"tsd-kind-class"},{"id":1651,"kind":2048,"name":"caseInsensitiveMultiMap","url":"classes/multimap.html#caseinsensitivemultimap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MultiMap"},{"id":1652,"kind":2048,"name":"get","url":"classes/multimap.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1653,"kind":2048,"name":"getAll","url":"classes/multimap.html#getall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1654,"kind":2048,"name":"contains","url":"classes/multimap.html#contains","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1655,"kind":2048,"name":"isEmpty","url":"classes/multimap.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1656,"kind":2048,"name":"names","url":"classes/multimap.html#names","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1657,"kind":2048,"name":"add","url":"classes/multimap.html#add","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1658,"kind":2048,"name":"addAll","url":"classes/multimap.html#addall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1659,"kind":2048,"name":"set","url":"classes/multimap.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1660,"kind":2048,"name":"setAll","url":"classes/multimap.html#setall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1661,"kind":2048,"name":"remove","url":"classes/multimap.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1662,"kind":2048,"name":"clear","url":"classes/multimap.html#clear","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1663,"kind":2048,"name":"size","url":"classes/multimap.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MultiMap"},{"id":1664,"kind":128,"name":"MxRecord","url":"classes/mxrecord.html","classes":"tsd-kind-class"},{"id":1665,"kind":2048,"name":"priority","url":"classes/mxrecord.html#priority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MxRecord"},{"id":1666,"kind":2048,"name":"name","url":"classes/mxrecord.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MxRecord"},{"id":1667,"kind":128,"name":"NetClient","url":"classes/netclient.html","classes":"tsd-kind-class"},{"id":1668,"kind":2048,"name":"isMetricsEnabled","url":"classes/netclient.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClient"},{"id":1669,"kind":2048,"name":"connect","url":"classes/netclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClient"},{"id":1670,"kind":2048,"name":"close","url":"classes/netclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetClient"},{"id":1671,"kind":128,"name":"NetServer","url":"classes/netserver.html","classes":"tsd-kind-class"},{"id":1672,"kind":2048,"name":"isMetricsEnabled","url":"classes/netserver.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1673,"kind":2048,"name":"connectStream","url":"classes/netserver.html#connectstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1674,"kind":2048,"name":"connectHandler","url":"classes/netserver.html#connecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1675,"kind":2048,"name":"listen","url":"classes/netserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1676,"kind":2048,"name":"close","url":"classes/netserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1677,"kind":2048,"name":"actualPort","url":"classes/netserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetServer"},{"id":1678,"kind":128,"name":"NetSocket","url":"classes/netsocket.html","classes":"tsd-kind-class"},{"id":1679,"kind":2048,"name":"end","url":"classes/netsocket.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1680,"kind":2048,"name":"writeQueueFull","url":"classes/netsocket.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1681,"kind":2048,"name":"exceptionHandler","url":"classes/netsocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1682,"kind":2048,"name":"handler","url":"classes/netsocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1683,"kind":2048,"name":"pause","url":"classes/netsocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1684,"kind":2048,"name":"resume","url":"classes/netsocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1685,"kind":2048,"name":"fetch","url":"classes/netsocket.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1686,"kind":2048,"name":"endHandler","url":"classes/netsocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1687,"kind":2048,"name":"write","url":"classes/netsocket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1688,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/netsocket.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1689,"kind":2048,"name":"drainHandler","url":"classes/netsocket.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1690,"kind":2048,"name":"writeHandlerID","url":"classes/netsocket.html#writehandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1691,"kind":2048,"name":"sendFile","url":"classes/netsocket.html#sendfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1692,"kind":2048,"name":"remoteAddress","url":"classes/netsocket.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1693,"kind":2048,"name":"localAddress","url":"classes/netsocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1694,"kind":2048,"name":"close","url":"classes/netsocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1695,"kind":2048,"name":"closeHandler","url":"classes/netsocket.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1696,"kind":2048,"name":"upgradeToSsl","url":"classes/netsocket.html#upgradetossl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1697,"kind":2048,"name":"isSsl","url":"classes/netsocket.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1698,"kind":2048,"name":"indicatedServerName","url":"classes/netsocket.html#indicatedservername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"NetSocket"},{"id":1699,"kind":128,"name":"Pump","url":"classes/pump.html","classes":"tsd-kind-class"},{"id":1700,"kind":2048,"name":"pump","url":"classes/pump.html#pump-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"Pump"},{"id":1701,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/pump.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1702,"kind":2048,"name":"start","url":"classes/pump.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1703,"kind":2048,"name":"stop","url":"classes/pump.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1704,"kind":2048,"name":"numberPumped","url":"classes/pump.html#numberpumped","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pump"},{"id":1705,"kind":256,"name":"ReadStream","url":"interfaces/readstream.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":1706,"kind":2048,"name":"exceptionHandler","url":"interfaces/readstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"ReadStream"},{"id":1707,"kind":2048,"name":"handler","url":"interfaces/readstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1708,"kind":2048,"name":"pause","url":"interfaces/readstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1709,"kind":2048,"name":"resume","url":"interfaces/readstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1710,"kind":2048,"name":"fetch","url":"interfaces/readstream.html#fetch","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1711,"kind":2048,"name":"endHandler","url":"interfaces/readstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ReadStream"},{"id":1712,"kind":128,"name":"RecordParser","url":"classes/recordparser.html","classes":"tsd-kind-class"},{"id":1713,"kind":2048,"name":"setOutput","url":"classes/recordparser.html#setoutput","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1714,"kind":2048,"name":"newDelimited","url":"classes/recordparser.html#newdelimited","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RecordParser"},{"id":1715,"kind":2048,"name":"newFixed","url":"classes/recordparser.html#newfixed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RecordParser"},{"id":1716,"kind":2048,"name":"delimitedMode","url":"classes/recordparser.html#delimitedmode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1717,"kind":2048,"name":"fixedSizeMode","url":"classes/recordparser.html#fixedsizemode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1718,"kind":2048,"name":"maxRecordSize","url":"classes/recordparser.html#maxrecordsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1719,"kind":2048,"name":"handle","url":"classes/recordparser.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1720,"kind":2048,"name":"exceptionHandler","url":"classes/recordparser.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1721,"kind":2048,"name":"handler","url":"classes/recordparser.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1722,"kind":2048,"name":"pause","url":"classes/recordparser.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1723,"kind":2048,"name":"fetch","url":"classes/recordparser.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1724,"kind":2048,"name":"resume","url":"classes/recordparser.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1725,"kind":2048,"name":"endHandler","url":"classes/recordparser.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordParser"},{"id":1726,"kind":128,"name":"SelfSignedCertificate","url":"classes/selfsignedcertificate.html","classes":"tsd-kind-class"},{"id":1727,"kind":2048,"name":"keyCertOptions","url":"classes/selfsignedcertificate.html#keycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1728,"kind":2048,"name":"trustOptions","url":"classes/selfsignedcertificate.html#trustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1729,"kind":2048,"name":"privateKeyPath","url":"classes/selfsignedcertificate.html#privatekeypath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1730,"kind":2048,"name":"certificatePath","url":"classes/selfsignedcertificate.html#certificatepath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1731,"kind":2048,"name":"delete","url":"classes/selfsignedcertificate.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SelfSignedCertificate"},{"id":1732,"kind":2048,"name":"create","url":"classes/selfsignedcertificate.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SelfSignedCertificate"},{"id":1733,"kind":128,"name":"ServerWebSocket","url":"classes/serverwebsocket.html","classes":"tsd-kind-class"},{"id":1734,"kind":2048,"name":"end","url":"classes/serverwebsocket.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1735,"kind":2048,"name":"writeQueueFull","url":"classes/serverwebsocket.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1736,"kind":2048,"name":"binaryHandlerID","url":"classes/serverwebsocket.html#binaryhandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1737,"kind":2048,"name":"textHandlerID","url":"classes/serverwebsocket.html#texthandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1738,"kind":2048,"name":"subProtocol","url":"classes/serverwebsocket.html#subprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1739,"kind":2048,"name":"writeTextMessage","url":"classes/serverwebsocket.html#writetextmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1740,"kind":2048,"name":"writePing","url":"classes/serverwebsocket.html#writeping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1741,"kind":2048,"name":"writePong","url":"classes/serverwebsocket.html#writepong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1742,"kind":2048,"name":"textMessageHandler","url":"classes/serverwebsocket.html#textmessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1743,"kind":2048,"name":"binaryMessageHandler","url":"classes/serverwebsocket.html#binarymessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1744,"kind":2048,"name":"pongHandler","url":"classes/serverwebsocket.html#ponghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1745,"kind":2048,"name":"close","url":"classes/serverwebsocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1746,"kind":2048,"name":"remoteAddress","url":"classes/serverwebsocket.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1747,"kind":2048,"name":"localAddress","url":"classes/serverwebsocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1748,"kind":2048,"name":"isSsl","url":"classes/serverwebsocket.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1749,"kind":2048,"name":"exceptionHandler","url":"classes/serverwebsocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1750,"kind":2048,"name":"handler","url":"classes/serverwebsocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1751,"kind":2048,"name":"pause","url":"classes/serverwebsocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1752,"kind":2048,"name":"resume","url":"classes/serverwebsocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1753,"kind":2048,"name":"fetch","url":"classes/serverwebsocket.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1754,"kind":2048,"name":"endHandler","url":"classes/serverwebsocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1755,"kind":2048,"name":"write","url":"classes/serverwebsocket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1756,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/serverwebsocket.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1757,"kind":2048,"name":"drainHandler","url":"classes/serverwebsocket.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1758,"kind":2048,"name":"writeFrame","url":"classes/serverwebsocket.html#writeframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1759,"kind":2048,"name":"writeFinalTextFrame","url":"classes/serverwebsocket.html#writefinaltextframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1760,"kind":2048,"name":"writeFinalBinaryFrame","url":"classes/serverwebsocket.html#writefinalbinaryframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1761,"kind":2048,"name":"writeBinaryMessage","url":"classes/serverwebsocket.html#writebinarymessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1762,"kind":2048,"name":"closeHandler","url":"classes/serverwebsocket.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1763,"kind":2048,"name":"frameHandler","url":"classes/serverwebsocket.html#framehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1764,"kind":2048,"name":"uri","url":"classes/serverwebsocket.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1765,"kind":2048,"name":"path","url":"classes/serverwebsocket.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1766,"kind":2048,"name":"query","url":"classes/serverwebsocket.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1767,"kind":2048,"name":"headers","url":"classes/serverwebsocket.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1768,"kind":2048,"name":"accept","url":"classes/serverwebsocket.html#accept","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1769,"kind":2048,"name":"reject","url":"classes/serverwebsocket.html#reject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerWebSocket"},{"id":1770,"kind":128,"name":"SharedData","url":"classes/shareddata.html","classes":"tsd-kind-class"},{"id":1771,"kind":2048,"name":"getClusterWideMap","url":"classes/shareddata.html#getclusterwidemap","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"SharedData"},{"id":1772,"kind":2048,"name":"getAsyncMap","url":"classes/shareddata.html#getasyncmap","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"SharedData"},{"id":1773,"kind":2048,"name":"getLock","url":"classes/shareddata.html#getlock","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1774,"kind":2048,"name":"getLockWithTimeout","url":"classes/shareddata.html#getlockwithtimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1775,"kind":2048,"name":"getCounter","url":"classes/shareddata.html#getcounter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SharedData"},{"id":1776,"kind":2048,"name":"getLocalMap","url":"classes/shareddata.html#getlocalmap","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"SharedData"},{"id":1777,"kind":128,"name":"SocketAddress","url":"classes/socketaddress.html","classes":"tsd-kind-class"},{"id":1778,"kind":2048,"name":"inetSocketAddress","url":"classes/socketaddress.html#inetsocketaddress","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SocketAddress"},{"id":1779,"kind":2048,"name":"domainSocketAddress","url":"classes/socketaddress.html#domainsocketaddress","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SocketAddress"},{"id":1780,"kind":2048,"name":"host","url":"classes/socketaddress.html#host","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SocketAddress"},{"id":1781,"kind":2048,"name":"port","url":"classes/socketaddress.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SocketAddress"},{"id":1782,"kind":2048,"name":"path","url":"classes/socketaddress.html#path","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SocketAddress"},{"id":1783,"kind":128,"name":"SrvRecord","url":"classes/srvrecord.html","classes":"tsd-kind-class"},{"id":1784,"kind":2048,"name":"priority","url":"classes/srvrecord.html#priority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1785,"kind":2048,"name":"weight","url":"classes/srvrecord.html#weight","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1786,"kind":2048,"name":"port","url":"classes/srvrecord.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1787,"kind":2048,"name":"name","url":"classes/srvrecord.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1788,"kind":2048,"name":"protocol","url":"classes/srvrecord.html#protocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1789,"kind":2048,"name":"service","url":"classes/srvrecord.html#service","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1790,"kind":2048,"name":"target","url":"classes/srvrecord.html#target","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SrvRecord"},{"id":1791,"kind":256,"name":"StreamBase","url":"interfaces/streambase.html","classes":"tsd-kind-interface"},{"id":1792,"kind":2048,"name":"exceptionHandler","url":"interfaces/streambase.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"StreamBase"},{"id":1793,"kind":128,"name":"TimeoutStream","url":"classes/timeoutstream.html","classes":"tsd-kind-class"},{"id":1794,"kind":2048,"name":"exceptionHandler","url":"classes/timeoutstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1795,"kind":2048,"name":"handler","url":"classes/timeoutstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1796,"kind":2048,"name":"pause","url":"classes/timeoutstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1797,"kind":2048,"name":"resume","url":"classes/timeoutstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1798,"kind":2048,"name":"fetch","url":"classes/timeoutstream.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1799,"kind":2048,"name":"endHandler","url":"classes/timeoutstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1800,"kind":2048,"name":"cancel","url":"classes/timeoutstream.html#cancel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TimeoutStream"},{"id":1801,"kind":128,"name":"Vertx","url":"classes/vertx.html","classes":"tsd-kind-class"},{"id":1802,"kind":2048,"name":"isMetricsEnabled","url":"classes/vertx.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1803,"kind":2048,"name":"vertx","url":"classes/vertx.html#vertx-1","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Vertx"},{"id":1804,"kind":2048,"name":"clusteredVertx","url":"classes/vertx.html#clusteredvertx","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Vertx"},{"id":1805,"kind":2048,"name":"currentContext","url":"classes/vertx.html#currentcontext","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Vertx"},{"id":1806,"kind":2048,"name":"getOrCreateContext","url":"classes/vertx.html#getorcreatecontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1807,"kind":2048,"name":"createNetServer","url":"classes/vertx.html#createnetserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1808,"kind":2048,"name":"createNetClient","url":"classes/vertx.html#createnetclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1809,"kind":2048,"name":"createHttpServer","url":"classes/vertx.html#createhttpserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1810,"kind":2048,"name":"createHttpClient","url":"classes/vertx.html#createhttpclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1811,"kind":2048,"name":"createDatagramSocket","url":"classes/vertx.html#createdatagramsocket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1812,"kind":2048,"name":"fileSystem","url":"classes/vertx.html#filesystem","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1813,"kind":2048,"name":"eventBus","url":"classes/vertx.html#eventbus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1814,"kind":2048,"name":"createDnsClient","url":"classes/vertx.html#creatednsclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1815,"kind":2048,"name":"sharedData","url":"classes/vertx.html#shareddata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1816,"kind":2048,"name":"setTimer","url":"classes/vertx.html#settimer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1817,"kind":2048,"name":"timerStream","url":"classes/vertx.html#timerstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1818,"kind":2048,"name":"setPeriodic","url":"classes/vertx.html#setperiodic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1819,"kind":2048,"name":"periodicStream","url":"classes/vertx.html#periodicstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1820,"kind":2048,"name":"cancelTimer","url":"classes/vertx.html#canceltimer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1821,"kind":2048,"name":"runOnContext","url":"classes/vertx.html#runoncontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1822,"kind":2048,"name":"close","url":"classes/vertx.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1823,"kind":2048,"name":"deployVerticle","url":"classes/vertx.html#deployverticle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1824,"kind":2048,"name":"undeploy","url":"classes/vertx.html#undeploy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1825,"kind":2048,"name":"deploymentIDs","url":"classes/vertx.html#deploymentids","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1826,"kind":2048,"name":"isClustered","url":"classes/vertx.html#isclustered","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1827,"kind":2048,"name":"executeBlocking","url":"classes/vertx.html#executeblocking","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Vertx"},{"id":1828,"kind":2048,"name":"createSharedWorkerExecutor","url":"classes/vertx.html#createsharedworkerexecutor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1829,"kind":2048,"name":"isNativeTransportEnabled","url":"classes/vertx.html#isnativetransportenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1830,"kind":2048,"name":"exceptionHandler","url":"classes/vertx.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Vertx"},{"id":1831,"kind":128,"name":"WebSocket","url":"classes/websocket.html","classes":"tsd-kind-class"},{"id":1832,"kind":2048,"name":"end","url":"classes/websocket.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1833,"kind":2048,"name":"writeQueueFull","url":"classes/websocket.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1834,"kind":2048,"name":"binaryHandlerID","url":"classes/websocket.html#binaryhandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1835,"kind":2048,"name":"textHandlerID","url":"classes/websocket.html#texthandlerid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1836,"kind":2048,"name":"subProtocol","url":"classes/websocket.html#subprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1837,"kind":2048,"name":"writePing","url":"classes/websocket.html#writeping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1838,"kind":2048,"name":"writePong","url":"classes/websocket.html#writepong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1839,"kind":2048,"name":"textMessageHandler","url":"classes/websocket.html#textmessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1840,"kind":2048,"name":"binaryMessageHandler","url":"classes/websocket.html#binarymessagehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1841,"kind":2048,"name":"pongHandler","url":"classes/websocket.html#ponghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1842,"kind":2048,"name":"close","url":"classes/websocket.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1843,"kind":2048,"name":"remoteAddress","url":"classes/websocket.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1844,"kind":2048,"name":"localAddress","url":"classes/websocket.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1845,"kind":2048,"name":"isSsl","url":"classes/websocket.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1846,"kind":2048,"name":"exceptionHandler","url":"classes/websocket.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1847,"kind":2048,"name":"handler","url":"classes/websocket.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1848,"kind":2048,"name":"pause","url":"classes/websocket.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1849,"kind":2048,"name":"resume","url":"classes/websocket.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1850,"kind":2048,"name":"fetch","url":"classes/websocket.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1851,"kind":2048,"name":"endHandler","url":"classes/websocket.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1852,"kind":2048,"name":"write","url":"classes/websocket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1853,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/websocket.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1854,"kind":2048,"name":"drainHandler","url":"classes/websocket.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1855,"kind":2048,"name":"writeFrame","url":"classes/websocket.html#writeframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1856,"kind":2048,"name":"writeFinalTextFrame","url":"classes/websocket.html#writefinaltextframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1857,"kind":2048,"name":"writeFinalBinaryFrame","url":"classes/websocket.html#writefinalbinaryframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1858,"kind":2048,"name":"writeBinaryMessage","url":"classes/websocket.html#writebinarymessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1859,"kind":2048,"name":"writeTextMessage","url":"classes/websocket.html#writetextmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1860,"kind":2048,"name":"closeHandler","url":"classes/websocket.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1861,"kind":2048,"name":"frameHandler","url":"classes/websocket.html#framehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocket"},{"id":1862,"kind":256,"name":"WebSocketBase","url":"interfaces/websocketbase.html","classes":"tsd-kind-interface"},{"id":1863,"kind":2048,"name":"end","url":"interfaces/websocketbase.html#end","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1864,"kind":2048,"name":"writeQueueFull","url":"interfaces/websocketbase.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1865,"kind":2048,"name":"exceptionHandler","url":"interfaces/websocketbase.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1866,"kind":2048,"name":"handler","url":"interfaces/websocketbase.html#handler","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1867,"kind":2048,"name":"pause","url":"interfaces/websocketbase.html#pause","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1868,"kind":2048,"name":"resume","url":"interfaces/websocketbase.html#resume","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1869,"kind":2048,"name":"fetch","url":"interfaces/websocketbase.html#fetch","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1870,"kind":2048,"name":"endHandler","url":"interfaces/websocketbase.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1871,"kind":2048,"name":"write","url":"interfaces/websocketbase.html#write","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1872,"kind":2048,"name":"setWriteQueueMaxSize","url":"interfaces/websocketbase.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1873,"kind":2048,"name":"drainHandler","url":"interfaces/websocketbase.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WebSocketBase"},{"id":1874,"kind":2048,"name":"binaryHandlerID","url":"interfaces/websocketbase.html#binaryhandlerid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1875,"kind":2048,"name":"textHandlerID","url":"interfaces/websocketbase.html#texthandlerid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1876,"kind":2048,"name":"subProtocol","url":"interfaces/websocketbase.html#subprotocol","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1877,"kind":2048,"name":"writeFrame","url":"interfaces/websocketbase.html#writeframe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1878,"kind":2048,"name":"writeFinalTextFrame","url":"interfaces/websocketbase.html#writefinaltextframe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1879,"kind":2048,"name":"writeFinalBinaryFrame","url":"interfaces/websocketbase.html#writefinalbinaryframe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1880,"kind":2048,"name":"writeBinaryMessage","url":"interfaces/websocketbase.html#writebinarymessage","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1881,"kind":2048,"name":"writeTextMessage","url":"interfaces/websocketbase.html#writetextmessage","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1882,"kind":2048,"name":"writePing","url":"interfaces/websocketbase.html#writeping","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1883,"kind":2048,"name":"writePong","url":"interfaces/websocketbase.html#writepong","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1884,"kind":2048,"name":"closeHandler","url":"interfaces/websocketbase.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1885,"kind":2048,"name":"frameHandler","url":"interfaces/websocketbase.html#framehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1886,"kind":2048,"name":"textMessageHandler","url":"interfaces/websocketbase.html#textmessagehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1887,"kind":2048,"name":"binaryMessageHandler","url":"interfaces/websocketbase.html#binarymessagehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1888,"kind":2048,"name":"pongHandler","url":"interfaces/websocketbase.html#ponghandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1889,"kind":2048,"name":"close","url":"interfaces/websocketbase.html#close","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1890,"kind":2048,"name":"remoteAddress","url":"interfaces/websocketbase.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1891,"kind":2048,"name":"localAddress","url":"interfaces/websocketbase.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1892,"kind":2048,"name":"isSsl","url":"interfaces/websocketbase.html#isssl","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WebSocketBase"},{"id":1893,"kind":128,"name":"WebSocketFrame","url":"classes/websocketframe.html","classes":"tsd-kind-class"},{"id":1894,"kind":2048,"name":"binaryFrame","url":"classes/websocketframe.html#binaryframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1895,"kind":2048,"name":"textFrame","url":"classes/websocketframe.html#textframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1896,"kind":2048,"name":"pingFrame","url":"classes/websocketframe.html#pingframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1897,"kind":2048,"name":"pongFrame","url":"classes/websocketframe.html#pongframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1898,"kind":2048,"name":"continuationFrame","url":"classes/websocketframe.html#continuationframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebSocketFrame"},{"id":1899,"kind":2048,"name":"isText","url":"classes/websocketframe.html#istext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1900,"kind":2048,"name":"isBinary","url":"classes/websocketframe.html#isbinary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1901,"kind":2048,"name":"isContinuation","url":"classes/websocketframe.html#iscontinuation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1902,"kind":2048,"name":"isClose","url":"classes/websocketframe.html#isclose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1903,"kind":2048,"name":"textData","url":"classes/websocketframe.html#textdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1904,"kind":2048,"name":"binaryData","url":"classes/websocketframe.html#binarydata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1905,"kind":2048,"name":"isFinal","url":"classes/websocketframe.html#isfinal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1906,"kind":2048,"name":"closeStatusCode","url":"classes/websocketframe.html#closestatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1907,"kind":2048,"name":"closeReason","url":"classes/websocketframe.html#closereason","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebSocketFrame"},{"id":1908,"kind":128,"name":"WorkerExecutor","url":"classes/workerexecutor.html","classes":"tsd-kind-class"},{"id":1909,"kind":2048,"name":"isMetricsEnabled","url":"classes/workerexecutor.html#ismetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WorkerExecutor"},{"id":1910,"kind":2048,"name":"executeBlocking","url":"classes/workerexecutor.html#executeblocking","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"WorkerExecutor"},{"id":1911,"kind":2048,"name":"close","url":"classes/workerexecutor.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WorkerExecutor"},{"id":1912,"kind":256,"name":"WriteStream","url":"interfaces/writestream.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":1913,"kind":2048,"name":"exceptionHandler","url":"interfaces/writestream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite","parent":"WriteStream"},{"id":1914,"kind":2048,"name":"write","url":"interfaces/writestream.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1915,"kind":2048,"name":"end","url":"interfaces/writestream.html#end","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1916,"kind":2048,"name":"setWriteQueueMaxSize","url":"interfaces/writestream.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1917,"kind":2048,"name":"writeQueueFull","url":"interfaces/writestream.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1918,"kind":2048,"name":"drainHandler","url":"interfaces/writestream.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"WriteStream"},{"id":1919,"kind":2,"name":"__global","url":"modules/__global.html","classes":"tsd-kind-module tsd-is-not-exported"},{"id":1920,"kind":32,"name":"vertx","url":"modules/__global.html#vertx","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1921,"kind":32,"name":"require","url":"modules/__global.html#require","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1922,"kind":65536,"name":"__type","url":"modules/__global.html#require.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"__global.require"},{"id":1923,"kind":64,"name":"resolve","url":"modules/__global.html#require.__type-5.resolve","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.require.__type"},{"id":1924,"kind":32,"name":"cache","url":"modules/__global.html#require.__type-5.cache","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.require.__type"},{"id":1925,"kind":32,"name":"extensions","url":"modules/__global.html#require.__type-5.extensions","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.require.__type"},{"id":1926,"kind":32,"name":"process","url":"modules/__global.html#process","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1927,"kind":65536,"name":"__type","url":"modules/__global.html#process.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"__global.process"},{"id":1928,"kind":32,"name":"env","url":"modules/__global.html#process.__type-1.env","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1929,"kind":65536,"name":"__type","url":"modules/__global.html#process.__type-1.env.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"__global.process.__type.env"},{"id":1930,"kind":32,"name":"pid","url":"modules/__global.html#process.__type-1.pid","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1931,"kind":32,"name":"engine","url":"modules/__global.html#process.__type-1.engine","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1932,"kind":32,"name":"exit","url":"modules/__global.html#process.__type-1.exit","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1933,"kind":65536,"name":"__type","url":"modules/__global.html#process.__type-1.exit.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"__global.process.__type.exit"},{"id":1934,"kind":32,"name":"nextTick","url":"modules/__global.html#process.__type-1.nexttick","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1935,"kind":65536,"name":"__type","url":"modules/__global.html#process.__type-1.nexttick.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"__global.process.__type.nextTick"},{"id":1936,"kind":32,"name":"stdout","url":"modules/__global.html#process.__type-1.stdout","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1937,"kind":32,"name":"stderr","url":"modules/__global.html#process.__type-1.stderr","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1938,"kind":32,"name":"stdin","url":"modules/__global.html#process.__type-1.stdin","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.process.__type"},{"id":1939,"kind":32,"name":"Java","url":"modules/__global.html#java","classes":"tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1940,"kind":65536,"name":"__type","url":"modules/__global.html#java.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"__global.Java"},{"id":1941,"kind":64,"name":"type","url":"modules/__global.html#java.__type.type","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.Java.__type"},{"id":1942,"kind":64,"name":"from","url":"modules/__global.html#java.__type.from","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.Java.__type"},{"id":1943,"kind":64,"name":"to","url":"modules/__global.html#java.__type.to","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.Java.__type"},{"id":1944,"kind":64,"name":"isJavaObject","url":"modules/__global.html#java.__type.isjavaobject","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.Java.__type"},{"id":1945,"kind":64,"name":"isType","url":"modules/__global.html#java.__type.istype","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.Java.__type"},{"id":1946,"kind":64,"name":"typeName","url":"modules/__global.html#java.__type.typename","classes":"tsd-kind-function tsd-parent-kind-type-literal tsd-is-not-exported","parent":"__global.Java.__type"},{"id":1947,"kind":64,"name":"setTimeout","url":"modules/__global.html#settimeout","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1948,"kind":64,"name":"clearTimeout","url":"modules/__global.html#cleartimeout","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1949,"kind":64,"name":"setInterval","url":"modules/__global.html#setinterval","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1950,"kind":64,"name":"clearInterval","url":"modules/__global.html#clearinterval","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"__global"},{"id":1951,"kind":64,"name":"setImmediate","url":"modules/__global.html#setimmediate","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-not-exported","parent":"__global"}]}; \ No newline at end of file diff --git a/docs/@vertx/core/classes/addressresolveroptions.html b/docs/@vertx/core/classes/addressresolveroptions.html index 136b74b8d..9fd530e63 100644 --- a/docs/@vertx/core/classes/addressresolveroptions.html +++ b/docs/@vertx/core/classes/addressresolveroptions.html @@ -77,339 +77,900 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    cacheMaxTimeToLive

    -
    cacheMaxTimeToLive: number
    - -
    -
    -

    Set the cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL, - use this to set a maximum value to all responses TTL.

    -
    -
    -
    param
    -

    the cache max TTL in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    cacheMinTimeToLive

    -
    cacheMinTimeToLive: number
    - -
    -
    -

    Set the cache minimum TTL value in seconds. After resolution successful IP addresses are cached with their DNS response TTL, - use this to set a minimum value to all responses TTL.

    -
    -
    -
    param
    -

    the cache min TTL in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addSearchDomain

    + +
      +
    • + +
      +
      +

      Set the lists of DNS search domains. +

      + When the search domain list is null, the effective search domain list will be populated using + the system DNS search domains.

      +
      +
      +

      Parameters

      +
        +
      • +
        searchDomains: string
        +
        +

        the search domains

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +
      • +
    -
    - -

    cacheNegativeTimeToLive

    -
    cacheNegativeTimeToLive: number
    - -
    -
    -

    Set the negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried - for a period of time equals to the negative TTL. This allows to reduce the response time of negative replies - and reduce the amount of messages to DNS servers.

    -
    -
    -
    param
    -

    the cache negative TTL in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addServer

    + +
      +
    • + +
      +
      +

      Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional + colon and a port, e.g {@code 8.8.8.8} or {code 192.168.0.1:40000}. When the list is empty, the resolver + will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved + it will use Google's public DNS servers {@code "8.8.8.8"} and {@code "8.8.4.4"}.

      +
      +
      +

      Parameters

      +
        +
      • +
        servers: string
        +
        +

        the list of DNS servers

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    hostsPath

    -
    hostsPath: string
    - -
    -
    -

    Set the path of an alternate hosts configuration file to use instead of the one provided by the os. -

    - The default value is null, so the operating system hosts config is used.

    -
    -
    -
    param
    -

    the hosts path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCacheMaxTimeToLive

    +
      +
    • getCacheMaxTimeToLive(): number
      • +
    +
      +
    • + +
      +
      +

      Set the cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL, + use this to set a maximum value to all responses TTL.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    hostsValue

    -
    hostsValue: Buffer
    - -
    -
    -

    Set an alternate hosts configuration file to use instead of the one provided by the os. -

    - The value should contain the hosts content literaly, for instance 127.0.0.1 localhost -

    - The default value is null, so the operating system hosts config is used.

    -
    -
    -
    param
    -

    the hosts content

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCacheMinTimeToLive

    +
      +
    • getCacheMinTimeToLive(): number
      • +
    +
      +
    • + +
      +
      +

      Set the cache minimum TTL value in seconds. After resolution successful IP addresses are cached with their DNS response TTL, + use this to set a minimum value to all responses TTL.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxQueries

    -
    maxQueries: number
    - -
    -
    -

    Set the maximum number of queries when an hostname is resolved.

    -
    -
    -
    param
    -

    the max number of queries to be sent

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCacheNegativeTimeToLive

    +
      +
    • getCacheNegativeTimeToLive(): number
      • +
    +
      +
    • + +
      +
      +

      Set the negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried + for a period of time equals to the negative TTL. This allows to reduce the response time of negative replies + and reduce the amount of messages to DNS servers.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ndots

    -
    ndots: number
    - -
    -
    -

    Set the ndots value used when resolving using search domains, the default value is {@code -1} which - determines the value from the OS on Linux or uses the value {@code 1}.

    -
    -
    -
    param
    -

    the new ndots value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHostsPath

    +
      +
    • getHostsPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the path of an alternate hosts configuration file to use instead of the one provided by the os. +

      + The default value is null, so the operating system hosts config is used.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    optResourceEnabled

    -
    optResourceEnabled: boolean
    - -
    -
    -

    Set to true to enable the automatic inclusion in DNS queries of an optional record that hints - the remote DNS server about how much data the resolver can read per response.

    -
    -
    -
    param
    -

    true to enable, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHostsValue

    + +
      +
    • + +
      +
      +

      Set an alternate hosts configuration file to use instead of the one provided by the os. +

      + The value should contain the hosts content literaly, for instance 127.0.0.1 localhost +

      + The default value is null, so the operating system hosts config is used.

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    queryTimeout

    -
    queryTimeout: number
    - -
    -
    -

    Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

    -
    -
    -
    param
    -

    the query timeout in milliseconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxQueries

    +
      +
    • getMaxQueries(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum number of queries when an hostname is resolved.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    rdFlag

    -
    rdFlag: boolean
    - -
    -
    -

    Set the DNS queries Recursion Desired flag value.

    -
    -
    -
    param
    -

    the flag value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getNdots

    +
      +
    • getNdots(): number
      • +
    +
      +
    • + +
      +
      +

      Set the ndots value used when resolving using search domains, the default value is {@code -1} which + determines the value from the OS on Linux or uses the value {@code 1}.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    rotateServers

    -
    rotateServers: boolean
    - -
    -
    -

    Set to {@code true} to enable round-robin selection of the dns server to use. It spreads the query load - among the servers and avoids all lookup to hit the first server of the list.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getQueryTimeout

    +
      +
    • getQueryTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    searchDomains

    -
    searchDomains: string
    - -
    -
    -

    Set the lists of DNS search domains. -

    - When the search domain list is null, the effective search domain list will be populated using - the system DNS search domains.

    -
    -
    -
    param
    -

    the search domains

    -
    -
    -
    +
    + +

    getRdFlag

    +
      +
    • getRdFlag(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the DNS queries Recursion Desired flag value.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    servers

    -
    servers: string
    - -
    -
    -

    Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional - colon and a port, e.g {@code 8.8.8.8} or {code 192.168.0.1:40000}. When the list is empty, the resolver - will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved - it will use Google's public DNS servers {@code "8.8.8.8"} and {@code "8.8.4.4"}.

    -
    -
    -
    param
    -

    the list of DNS servers

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getSearchDomains

    +
      +
    • getSearchDomains(): string
      • +
    +
      +
    • + +
      +
      +

      Set the lists of DNS search domains. +

      + When the search domain list is null, the effective search domain list will be populated using + the system DNS search domains.

      +
      +
      +

      Returns string

      +
      • +
    +
    +
    + +

    getServers

    +
      +
    • getServers(): string
      • +
    +
      +
    • + +
      +
      +

      Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional + colon and a port, e.g {@code 8.8.8.8} or {code 192.168.0.1:40000}. When the list is empty, the resolver + will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved + it will use Google's public DNS servers {@code "8.8.8.8"} and {@code "8.8.4.4"}.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isOptResourceEnabled

    +
      +
    • isOptResourceEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to true to enable the automatic inclusion in DNS queries of an optional record that hints + the remote DNS server about how much data the resolver can read per response.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isRotateServers

    +
      +
    • isRotateServers(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to {@code true} to enable round-robin selection of the dns server to use. It spreads the query load + among the servers and avoids all lookup to hit the first server of the list.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCacheMaxTimeToLive

    + +
      +
    • + +
      +
      +

      Set the cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL, + use this to set a maximum value to all responses TTL.

      +
      +
      +

      Parameters

      +
        +
      • +
        cacheMaxTimeToLive: number
        +
        +

        the cache max TTL in seconds

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCacheMinTimeToLive

    + +
      +
    • + +
      +
      +

      Set the cache minimum TTL value in seconds. After resolution successful IP addresses are cached with their DNS response TTL, + use this to set a minimum value to all responses TTL.

      +
      +
      +

      Parameters

      +
        +
      • +
        cacheMinTimeToLive: number
        +
        +

        the cache min TTL in seconds

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCacheNegativeTimeToLive

    + +
      +
    • + +
      +
      +

      Set the negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried + for a period of time equals to the negative TTL. This allows to reduce the response time of negative replies + and reduce the amount of messages to DNS servers.

      +
      +
      +

      Parameters

      +
        +
      • +
        cacheNegativeTimeToLive: number
        +
        +

        the cache negative TTL in seconds

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHostsPath

    + +
      +
    • + +
      +
      +

      Set the path of an alternate hosts configuration file to use instead of the one provided by the os. +

      + The default value is null, so the operating system hosts config is used.

      +
      +
      +

      Parameters

      +
        +
      • +
        hostsPath: string
        +
        +

        the hosts path

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHostsValue

    + +
      +
    • + +
      +
      +

      Set an alternate hosts configuration file to use instead of the one provided by the os. +

      + The value should contain the hosts content literaly, for instance 127.0.0.1 localhost +

      + The default value is null, so the operating system hosts config is used.

      +
      +
      +

      Parameters

      +
        +
      • +
        hostsValue: Buffer
        +
        +

        the hosts content

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxQueries

    + +
      +
    • + +
      +
      +

      Set the maximum number of queries when an hostname is resolved.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxQueries: number
        +
        +

        the max number of queries to be sent

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setNdots

    + +
      +
    • + +
      +
      +

      Set the ndots value used when resolving using search domains, the default value is {@code -1} which + determines the value from the OS on Linux or uses the value {@code 1}.

      +
      +
      +

      Parameters

      +
        +
      • +
        ndots: number
        +
        +

        the new ndots value

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setOptResourceEnabled

    + +
      +
    • + +
      +
      +

      Set to true to enable the automatic inclusion in DNS queries of an optional record that hints + the remote DNS server about how much data the resolver can read per response.

      +
      +
      +

      Parameters

      +
        +
      • +
        optResourceEnabled: boolean
        +
        +

        true to enable, false otherwise

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setQueryTimeout

    + +
      +
    • + +
      +
      +

      Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

      +
      +
      +

      Parameters

      +
        +
      • +
        queryTimeout: number
        +
        +

        the query timeout in milliseconds

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRdFlag

    + +
      +
    • + +
      +
      +

      Set the DNS queries Recursion Desired flag value.

      +
      +
      +

      Parameters

      +
        +
      • +
        rdFlag: boolean
        +
        +

        the flag value

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRotateServers

    + +
      +
    • + +
      +
      +

      Set to {@code true} to enable round-robin selection of the dns server to use. It spreads the query load + among the servers and avoids all lookup to hit the first server of the list.

      +
      +
      +

      Parameters

      +
        +
      • +
        rotateServers: boolean
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSearchDomains

    + +
      +
    • + +
      +
      +

      Set the lists of DNS search domains. +

      + When the search domain list is null, the effective search domain list will be populated using + the system DNS search domains.

      +
      +
      +

      Parameters

      +
        +
      • +
        searchDomains: string
        +
        +

        the search domains

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +
      • +
    +
    +
    + +

    setServers

    + +
      +
    • + +
      +
      +

      Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional + colon and a port, e.g {@code 8.8.8.8} or {code 192.168.0.1:40000}. When the list is empty, the resolver + will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved + it will use Google's public DNS servers {@code "8.8.8.8"} and {@code "8.8.4.4"}.

      +
      +
      +

      Parameters

      +
        +
      • +
        servers: string
        +
        +

        the list of DNS servers

        +
        +
        • +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -428,44 +989,92 @@

    servers

  • AddressResolverOptions
    • diff --git a/docs/@vertx/core/classes/argument.html b/docs/@vertx/core/classes/argument.html index b83e0d1f7..121d03211 100644 --- a/docs/@vertx/core/classes/argument.html +++ b/docs/@vertx/core/classes/argument.html @@ -77,182 +77,454 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    argName

    -
    argName: string
    - -
    -
    -

    Sets the argument name of this Argument.

    -
    -
    -
    param
    -

    the argument name, must not be {@code null}

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Argument

      +
      • +
    • + +

      Parameters

      + +

      Returns Argument

      +
      • +
    -
    - -

    defaultValue

    -
    defaultValue: string
    - -
    -
    -

    Sets the default value of this Argument.

    -
    -
    -
    param
    -

    the default value

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getArgName

    +
      +
    • getArgName(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the argument name of this Argument.

      +
      +
      +

      Returns string

      +

      the current Argument instance

      +
      • +
    -
    - -

    description

    -
    description: string
    - -
    -
    -

    Sets the description of the Argument.

    -
    -
    -
    param
    -

    the description

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +
    + +

    getDefaultValue

    +
      +
    • getDefaultValue(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the default value of this Argument.

      +
      +
      +

      Returns string

      +

      the current Argument instance

      +
      • +
    -
    - -

    hidden

    -
    hidden: boolean
    - -
    -
    -

    Sets whether or not the current Argument is hidden.

    -
    -
    -
    param
    -

    enables or disables the visibility of this Argument

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +
    + +

    getDescription

    +
      +
    • getDescription(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the description of the Argument.

      +
      +
      +

      Returns string

      +

      the current Argument instance

      +
      • +
    -
    - -

    index

    -
    index: number
    - -
    -
    -

    Sets the argument index.

    -
    -
    -
    param
    -

    the index, must not be negative

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +
    + +

    getIndex

    +
      +
    • getIndex(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the argument index.

      +
      +
      +

      Returns number

      +

      the current Argument instance

      +
      • +
    -
    - -

    multiValued

    -
    multiValued: boolean
    - -
    -
    -

    Sets whether or not the argument can receive several values. Only the last argument can receive several values.

    -
    -
    -
    param
    -

    to mark this argument as multi-valued.

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +
    + +

    isHidden

    +
      +
    • isHidden(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the current Argument is hidden.

      +
      +
      +

      Returns boolean

      +

      the current Argument instance

      +
      • +
    -
    - -

    required

    -
    required: boolean
    - -
    -
    -

    Sets whether or not the current Argument is required.

    -
    -
    -
    param
    -

    to make this argument mandatory, {@link false} otherwise

    -
    -
    returns
    -

    the current Argument instance

    -
    -
    -
    +
    + +

    isMultiValued

    +
      +
    • isMultiValued(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the argument can receive several values. Only the last argument can receive several values.

      +
      +
      +

      Returns boolean

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    isRequired

    +
      +
    • isRequired(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the current Argument is required.

      +
      +
      +

      Returns boolean

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setArgName

    +
      +
    • setArgName(argName: string): Argument
      • +
    +
      +
    • + +
      +
      +

      Sets the argument name of this Argument.

      +
      +
      +

      Parameters

      +
        +
      • +
        argName: string
        +
        +

        the argument name, must not be {@code null}

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setDefaultValue

    +
      +
    • setDefaultValue(defaultValue: string): Argument
      • +
    +
      +
    • + +
      +
      +

      Sets the default value of this Argument.

      +
      +
      +

      Parameters

      +
        +
      • +
        defaultValue: string
        +
        +

        the default value

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setDescription

    +
      +
    • setDescription(description: string): Argument
      • +
    +
      +
    • + +
      +
      +

      Sets the description of the Argument.

      +
      +
      +

      Parameters

      +
        +
      • +
        description: string
        +
        +

        the description

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setHidden

    +
      +
    • setHidden(hidden: boolean): Argument
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the current Argument is hidden.

      +
      +
      +

      Parameters

      +
        +
      • +
        hidden: boolean
        +
        +

        enables or disables the visibility of this Argument

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setIndex

    + +
      +
    • + +
      +
      +

      Sets the argument index.

      +
      +
      +

      Parameters

      +
        +
      • +
        index: number
        +
        +

        the index, must not be negative

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setMultiValued

    +
      +
    • setMultiValued(multiValued: boolean): Argument
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the argument can receive several values. Only the last argument can receive several values.

      +
      +
      +

      Parameters

      +
        +
      • +
        multiValued: boolean
        +
        +

        to mark this argument as multi-valued.

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    +
    +
    + +

    setRequired

    +
      +
    • setRequired(required: boolean): Argument
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the current Argument is required.

      +
      +
      +

      Parameters

      +
        +
      • +
        required: boolean
        +
        +

        to make this argument mandatory, {@link false} otherwise

        +
        +
        • +
      +

      Returns Argument

      +

      the current Argument instance

      +
      • +
    @@ -271,26 +543,50 @@

    required

  • Argument
    • diff --git a/docs/@vertx/core/classes/asyncfile.html b/docs/@vertx/core/classes/asyncfile.html index c90e37392..4fe944862 100644 --- a/docs/@vertx/core/classes/asyncfile.html +++ b/docs/@vertx/core/classes/asyncfile.html @@ -72,6 +72,13 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -84,6 +91,7 @@

    Methods

  • end
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • flush
  • handler
  • pause
    • @@ -113,12 +121,12 @@

    close

  • -

    Close the file. The actual close happens asynchronously.

    +

    Close the file. The actual close happens asynchronously.

    Returns void

    @@ -126,12 +134,12 @@

    Returns void
    -

    Close the file. The actual close happens asynchronously. +

    Close the file. The actual close happens asynchronously. The handler will be called when the close is complete, or an error occurs.

    @@ -145,17 +153,20 @@
    handler: function
      • @@ -176,7 +187,7 @@

      drainHandler

    • Parameters

      @@ -186,17 +197,19 @@
      handler: function
        • -
        • (result: void): void | null | undefined
          • +
        • (res: void): void | Handler<void> | null | undefined

        • Parameters

          • -
            result: void
            +
            res: void

          Returns void + | + Handler<void> | null | @@ -223,12 +236,12 @@

          end

        • -

          Same as {@link #end()} but writes some data to the stream before ending.

          +

          Same as {@link #end()} but writes some data to the stream before ending.

          Parameters

          @@ -241,13 +254,14 @@

          Returns void
        • -

          Close the file, see {@link #close()}.

          +

          Close the file, see {@link #close()}.

          Returns void

          @@ -264,7 +278,7 @@

          endHandler

        • Parameters

          @@ -274,17 +288,19 @@
          endHandler: function
            • -
            • (result: void): void | null | undefined
              • +
            • (res: void): void | Handler<void> | null | undefined

            • Parameters

              • -
                result: void
                +
                res: void

              Returns void + | + Handler<void> | null | @@ -310,7 +326,7 @@

              exceptionHandler

            • Parameters

              @@ -320,17 +336,19 @@
              handler: function
                • -
                • (result: Error): void | null | undefined
                  • +
                • (res: Error): void | Handler<Error> | null | undefined

                • Parameters

                  • -
                    result: Error
                    +
                    res: Error

                  Returns void + | + Handler<Error> | null | @@ -346,6 +364,30 @@

                  Returns + +

                  fetch

                  + +
                    +
                  • + +

                    Parameters

                    +
                      +
                    • +
                      amount: number
                      +
                      • +
                    +

                    Returns AsyncFile

                    +
                    • +
                  +

    • flush

    @@ -357,12 +399,12 @@

    flush

  • -

    Flush any writes made to this file to underlying persistent storage. +

    Flush any writes made to this file to underlying persistent storage.

    If the file was opened with {@code flush} set to {@code true} then calling this method will have no effect.

    @@ -375,12 +417,12 @@

    Returns
    -

    Same as {@link #flush} but the handler will be called when the flush is complete or if an error occurs

    +

    Same as {@link #flush} but the handler will be called when the flush is complete or if an error occurs

    Parameters

    @@ -390,17 +432,20 @@
    handler: function

    • -
    +

    getOptionValue

    -
      -
    • getOptionValue(name: string): Object | null
      • +
        +
      • getOptionValue<T>(name: string): T | null
      • -

        Gets the value of an option with the matching name (can be the long name, short name or arg name).

        +

        Gets the value of an option with the matching name (can be the long name, short name or arg name).

        +

        Type parameters

        +
          +
        • +

          T

          +
          +

          the expected type

          +
          +
          • +

        Parameters

        • @@ -264,7 +291,7 @@
          name: string
        -

        Returns Object +

        Returns T | null

        @@ -282,12 +309,12 @@

        getRawValueForArgument

      • -

        Gets the raw value of the given argument. Raw values are the values as given in the user command line.

        +

        Gets the raw value of the given argument. Raw values are the values as given in the user command line.

        Parameters

        @@ -317,12 +344,12 @@

        getRawValueForOption

      • -

        Gets the raw value of the given option. Raw values are the values as given in the user command line.

        +

        Gets the raw value of the given option. Raw values are the values as given in the user command line.

        Parameters

        @@ -352,12 +379,12 @@

        getRawValues

      • -

        Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

        +

        Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

        deprecated
        @@ -389,12 +416,12 @@

        getRawValuesForArgument

      • -

        Gets the raw values of the given argument. Raw values are simple "String", not converted to the argument type.

        +

        Gets the raw values of the given argument. Raw values are simple "String", not converted to the argument type.

        Parameters

        @@ -421,12 +448,12 @@

        getRawValuesForOption

      • -

        Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

        +

        Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

        Parameters

        @@ -453,12 +480,12 @@

        isArgumentAssigned

      • -

        Checks whether or not the given argument has been assigned in the command line.

        +

        Checks whether or not the given argument has been assigned in the command line.

        Parameters

        @@ -485,12 +512,12 @@

        isAskingForHelp

      • -

        Checks whether or not the user has passed a "help" option and is asking for help.

        +

        Checks whether or not the user has passed a "help" option and is asking for help.

        Returns boolean

        @@ -508,12 +535,12 @@

        isFlagEnabled

      • -

        Gets the value of an option marked as a flag. +

        Gets the value of an option marked as a flag.

        Calling this method an a non-flag option throws an {@link IllegalStateException}.

        @@ -542,12 +569,12 @@

        isOptionAssigned

      • -

        Checks whether or not the given option has been assigned in the command line.

        +

        Checks whether or not the given option has been assigned in the command line.

        Parameters

        @@ -574,12 +601,12 @@

        isSeenInCommandLine

      • -

        Checks whether or not the given option has been seen in the user command line.

        +

        Checks whether or not the given option has been seen in the user command line.

        Parameters

        @@ -606,12 +633,12 @@

        isValid

      • -

        Checks whether or not the command line is valid, i.e. all constraints from arguments and options have been +

        Checks whether or not the command line is valid, i.e. all constraints from arguments and options have been satisfied. This method is used when the parser validation is disabled.

        @@ -630,12 +657,12 @@

        Static create

      • -

        Creates a command line object from the CLI. This object is intended to be used by +

        Creates a command line object from the CLI. This object is intended to be used by the parser to set the argument and option values.

        @@ -679,10 +706,10 @@

        Returns cli

        • -
      • +
      • getArgumentValue
        • -
      • +
      • getOptionValue
      • diff --git a/docs/@vertx/core/classes/compositefuture.html b/docs/@vertx/core/classes/compositefuture.html index be5ef28bf..05df0aee7 100644 --- a/docs/@vertx/core/classes/compositefuture.html +++ b/docs/@vertx/core/classes/compositefuture.html @@ -68,7 +68,12 @@

        Class CompositeFuture

        Hierarchy

    @@ -79,25 +84,31 @@

    Index

    Methods

    @@ -105,22 +116,23 @@

    Methods

    Methods

    -
    +

    cause

    -
      +
      • cause(index: number): Error
      • -

        Returns a cause of a wrapped future

        +

        Returns a cause of a wrapped future

        Parameters

        @@ -136,23 +148,24 @@

        Returns Error

    -
    +

    complete

    -
      +
      • -

        Set the result. Any handler will be called, if there is one, and the future will be marked as completed.

        +

        Set the result. Any handler will be called, if there is one, and the future will be marked as completed.

        Parameters

        @@ -168,30 +181,32 @@

        Returns void
      • -

        Set this instance as result. Any handler will be called, if there is one, and the future will be marked as completed.

        +

        Set this instance as result. Any handler will be called, if there is one, and the future will be marked as completed.

        Returns void

    -
    +

    completer

    -
    -
    +

    compose

    -
      -
    • compose(handler: function, next: Future): Future
      • -
    • compose(mapper: function): Future
      • +
        +
      • compose<U>(handler: function, next: Future<U>): Future<U>
        • +
      • compose<U>(mapper: function): Future<U>
    -
    +
    + +

    fail

    +
      +
    • fail(cause: Error): void
      • +
    • fail(failureMessage: string): void
      • +
    +
      +
    • + +
      +
      +

      Set the failure. Any handler will be called, if there is one, and the future will be marked as completed.

      +
      +
      +

      Parameters

      +
        +
      • +
        cause: Error
        +
        +

        the failure cause

        +
        +
        • +
      +

      Returns void

      +
      • +
    • + +
      +
      +

      Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed.

      +
      +
      +

      Parameters

      +
        +
      • +
        failureMessage: string
        +
        +

        the failure message

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +

    failed

    -
      +
      • failed(index: number): boolean
      • -

        Returns true if a wrapped future is failed

        +

        Returns true if a wrapped future is failed

        Parameters

        @@ -359,22 +451,23 @@

        Returns boolean

    -
    +

    isComplete

    -
      +
      • isComplete(index: number): boolean
      • -

        Returns true if a wrapped future is completed

        +

        Returns true if a wrapped future is completed

        Parameters

        @@ -390,22 +483,23 @@

        Returns boolean

    -
    +

    map

    -
      -
    • map(mapper: function): Future
      • +
        +
      • map<U>(mapper: function): Future<U>
      • -

        Apply a {@code mapper} function on this future.

        +

        Apply a {@code mapper} function on this future.

        When this future succeeds, the {@code mapper} will be called with the completed value and this mapper returns a value. This value will complete the future returned by this method call.

        @@ -413,6 +507,12 @@

        map

        When this future fails, the failure will be propagated to the returned future and the {@code mapper} will not be called.

        +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        -

        Returns Future

        +

        Returns Future<U>

        the mapped future

    -
    +
    + +

    mapEmpty

    +
      +
    • mapEmpty<V>(): Future<V>
      • +
    +
      +
    • + +
      +
      +

      Map the result of a future to {@code null}.

      +
      +

      This is a conveniency for {@code future.map((T) null)} or {@code future.map((Void) null)}.

      +

      When this future succeeds, {@code null} will complete the future returned by this method call.

      +

      When this future fails, the failure will be propagated to the returned future.

      +
      +

      Type parameters

      +
        +
      • +

        V

        +
        • +
      +

      Returns Future<V>

      +

      the mapped future

      +
      • +
    +
    +

    otherwise

    -
      -
    • otherwise(mapper: function): Future
      • -
    • otherwise(value: CompositeFuture): Future
      • +
      • -

        Apply a {@code mapper} function on this future.

        +

        Apply a {@code mapper} function on this future.

        When this future fails, the {@code mapper} will be called with the completed value and this mapper returns a value. This value will complete the future returned by this method call.

        @@ -479,14 +613,14 @@
        mapper: function
    -
    +

    otherwiseEmpty

    -
      -
    • otherwiseEmpty(): Future
      • +
      • -

        Map the failure of a future to {@code null}.

        +

        Map the failure of a future to {@code null}.

        This is a convenience for {@code future.otherwise((T) null)}.

        When this future fails, the {@code null} value will complete the future returned by this method call.

        When this future succeeds, the result will be propagated to the returned future.

        -

        Returns Future

        +

        Returns Future<CompositeFuture>

        the mapped future

    -
    +

    recover

    -
      -
    • recover(mapper: function): Future
      • +
      • -

        Handles a failure of this Future by returning the result of another Future. +

        Handles a failure of this Future by returning the result of another Future. If the mapper fails, then the returned future will be failed with this failure.

        @@ -581,44 +718,45 @@
        mapper: function
      -

      Returns Future

      +

      Returns Future<CompositeFuture>

      A recovered future

    -
    +

    result

    -
    -

    Properties

    -
    - -

    codecName

    -
    codecName: string
    - -
    -
    -

    Set the codec name.

    -
    -
    -
    param
    -

    the codec name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    addHeader

    + +
      +
    • + +
      +
      +

      Add a message header. +

      + Message headers can be sent with any message and will be accessible with {@link io.vertx.core.eventbus.Message#headers} + at the recipient.

      +
      +
      +

      Parameters

      +
        +
      • +
        headers: string
        +
        • +
      +

      Returns DeliveryOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getCodecName

    +
      +
    • getCodecName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the codec name.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSendTimeout

    +
      +
    • getSendTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the send timeout.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +

    headers

    -
    headers: string
    - -
    -
    -

    Add a message header. +

      +
    • headers(): string
      • +
    +
      +
    • + +
      +
      +

      Add a message header. +

      + Message headers can be sent with any message and will be accessible with {@link io.vertx.core.eventbus.Message#headers} + at the recipient.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isLocalOnly

    +
      +
    • isLocalOnly(): boolean
      • +
    +
      +
    • + +
      +
      +

      Whether a message should be delivered to local consumers only. Defaults to {@code false}.

      +

      - Message headers can be sent with any message and will be accessible with {@link io.vertx.core.eventbus.Message#headers} - at the recipient.

      -
      -
      -
      param
      -

      the header key

      -
      -
      param
      -

      the header value

      -
      -
      returns
      -

      a reference to this, so the API can be used fluently

      -
      -
      - + This option is effective in clustered mode only and does not apply to reply messages. + +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sendTimeout

    -
    sendTimeout: number
    - -
    -
    -

    Set the send timeout.

    -
    -
    -
    param
    -

    the timeout value, in ms.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setCodecName

    + +
      +
    • + +
      +
      +

      Set the codec name.

      +
      +
      +

      Parameters

      +
        +
      • +
        codecName: string
        +
        +

        the codec name

        +
        +
        • +
      +

      Returns DeliveryOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLocalOnly

    + +
      +
    • + +
      +
      +

      Whether a message should be delivered to local consumers only. Defaults to {@code false}.

      +
      +

      + This option is effective in clustered mode only and does not apply to reply messages. +

      +

      Parameters

      +
        +
      • +
        localOnly: boolean
        +
        +

        to deliver to local consumers only, {@code false} otherwise

        +
        +
        • +
      +

      Returns DeliveryOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSendTimeout

    + +
      +
    • + +
      +
      +

      Set the send timeout.

      +
      +
      +

      Parameters

      +
        +
      • +
        sendTimeout: number
        +
        • +
      +

      Returns DeliveryOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -181,14 +376,32 @@

    sendTimeout

  • DeliveryOptions
    • diff --git a/docs/@vertx/core/classes/deploymentoptions.html b/docs/@vertx/core/classes/deploymentoptions.html index 22bd5981b..5c82828da 100644 --- a/docs/@vertx/core/classes/deploymentoptions.html +++ b/docs/@vertx/core/classes/deploymentoptions.html @@ -77,278 +77,784 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    config

    -
    config: object
    - -
    -
    -

    Set the JSON configuration that will be passed to the verticle(s) when it's deployed

    -
    -
    -
    param
    -

    the JSON config

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    extraClasspath

    -
    extraClasspath: string
    - -
    -
    -

    Set any extra classpath to be used when deploying the verticle. -

    - Ignored if no isolation group is set.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getConfig

    +
      +
    • getConfig(): object
      • +
    +
      +
    • + +
      +
      +

      Set the JSON configuration that will be passed to the verticle(s) when it's deployed

      +
      +
      +

      Returns object

      +

      a reference to this, so the API can be used fluently

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    ha

    -
    ha: boolean
    - -
    -
    -

    Set whether the verticle(s) will be deployed as HA.

    -
    -
    -
    param
    -

    true if to be deployed as HA, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getExtraClasspath

    +
      +
    • getExtraClasspath(): string
      • +
    +
      +
    • + +
      +
      +

      Set any extra classpath to be used when deploying the verticle. +

      + Ignored if no isolation group is set.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    instances

    -
    instances: number
    - -
    -
    -

    Set the number of instances that should be deployed.

    -
    -
    -
    param
    -

    the number of instances

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getInstances

    +
      +
    • getInstances(): number
      • +
    +
      +
    • + +
      +
      +

      Set the number of instances that should be deployed.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    isolatedClasses

    -
    isolatedClasses: string
    - -
    -
    -

    Set the isolated class names.

    -
    -
    -
    param
    -

    the list of isolated class names

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIsolatedClasses

    +
      +
    • getIsolatedClasses(): string
      • +
    +
      +
    • + +
      +
      +

      Set the isolated class names.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    isolationGroup

    -
    isolationGroup: string
    - -
    -
    -

    Set the isolation group that will be used when deploying the verticle(s)

    -
    -
    -
    param
    -

    the isolation group

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIsolationGroup

    +
      +
    • getIsolationGroup(): string
      • +
    +
      +
    • + +
      +
      +

      Set the isolation group that will be used when deploying the verticle(s)

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWorkerExecuteTime

    -
    maxWorkerExecuteTime: number
    - -
    -
    -

    Sets the value of max worker execute time, in ns.

    -
    -
    -
    param
    -

    the value of max worker execute time, in ns.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxWorkerExecuteTime

    +
      +
    • getMaxWorkerExecuteTime(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the value of max worker execute time, in {@link DeploymentOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit}. +

      + The default value of {@link DeploymentOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit} is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    multiThreaded

    -
    multiThreaded: boolean
    - -
    -
    -

    Set whether the verticle(s) should be deployed as a multi-threaded worker verticle

    -
    -
    -
    param
    -

    true for multi-threaded worker, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxWorkerExecuteTimeUnit

    +
      +
    • getMaxWorkerExecuteTimeUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code maxWorkerExecuteTime}

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    worker

    -
    worker: boolean
    - -
    -
    -

    Set whether the verticle(s) should be deployed as a worker verticle

    -
    -
    -
    param
    -

    true for worker, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getWorkerPoolName

    +
      +
    • getWorkerPoolName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the worker pool name to use for this verticle. When no name is set, the Vert.x + worker pool will be used, when a name is set, the verticle will use a named worker pool.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    workerPoolName

    -
    workerPoolName: string
    - -
    -
    -

    Set the worker pool name to use for this verticle. When no name is set, the Vert.x - worker pool will be used, when a name is set, the verticle will use a named worker pool.

    -
    -
    -
    param
    -

    the worker pool name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getWorkerPoolSize

    +
      +
    • getWorkerPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum number of worker threads to be used by the Vert.x instance.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    workerPoolSize

    -
    workerPoolSize: number
    - -
    -
    -

    Set the maximum number of worker threads to be used by the Vert.x instance.

    -
    -
    -
    param
    -

    the number of threads

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isHa

    +
      +
    • isHa(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the verticle(s) will be deployed as HA.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isMultiThreaded

    +
      +
    • isMultiThreaded(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the verticle(s) should be deployed as a multi-threaded worker verticle. +

      + WARNING: Multi-threaded worker verticles are a deprecated feature. +

      + Most applications will have no need for them. Because of the concurrency in these verticles you have to be + very careful to keep the verticle in a consistent state using standard Java techniques for multi-threaded + programming. +

      + You can read the documentation that explains how you can replace this feature by the usage of custom worker + pools or {@code executeBlocking} calls.

      +
      +
      +
      deprecated
      +

      as of 3.6.0

      +
      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isWorker

    +
      +
    • isWorker(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the verticle(s) should be deployed as a worker verticle

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConfig

    + +
      +
    • + +
      +
      +

      Set the JSON configuration that will be passed to the verticle(s) when it's deployed

      +
      +
      +

      Parameters

      +
        +
      • +
        config: object
        +
        +

        the JSON config

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setExtraClasspath

    + +
      +
    • + +
      +
      +

      Set any extra classpath to be used when deploying the verticle. +

      + Ignored if no isolation group is set.

      +
      +
      +

      Parameters

      +
        +
      • +
        extraClasspath: string
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHa

    + +
      +
    • + +
      +
      +

      Set whether the verticle(s) will be deployed as HA.

      +
      +
      +

      Parameters

      +
        +
      • +
        ha: boolean
        +
        +

        true if to be deployed as HA, false otherwise

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setInstances

    + +
      +
    • + +
      +
      +

      Set the number of instances that should be deployed.

      +
      +
      +

      Parameters

      +
        +
      • +
        instances: number
        +
        +

        the number of instances

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIsolatedClasses

    + +
      +
    • + +
      +
      +

      Set the isolated class names.

      +
      +
      +

      Parameters

      +
        +
      • +
        isolatedClasses: string
        +
        +

        the list of isolated class names

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIsolationGroup

    + +
      +
    • + +
      +
      +

      Set the isolation group that will be used when deploying the verticle(s)

      +
      +
      +

      Parameters

      +
        +
      • +
        isolationGroup: string
        +
        +

        the isolation group

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWorkerExecuteTime

    + +
      +
    • + +
      +
      +

      Sets the value of max worker execute time, in {@link DeploymentOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit}. +

      + The default value of {@link DeploymentOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit} is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWorkerExecuteTime: number
        +
        +

        the value of max worker execute time, in in {@link DeploymentOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit}.

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWorkerExecuteTimeUnit

    + +
      +
    • + +
      +
      +

      Set the time unit of {@code maxWorkerExecuteTime}

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWorkerExecuteTimeUnit: any
        +
        +

        the time unit of {@code maxWorkerExecuteTime}

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMultiThreaded

    + +
      +
    • + +
      +
      +

      Set whether the verticle(s) should be deployed as a multi-threaded worker verticle. +

      + WARNING: Multi-threaded worker verticles are a deprecated feature. +

      + Most applications will have no need for them. Because of the concurrency in these verticles you have to be + very careful to keep the verticle in a consistent state using standard Java techniques for multi-threaded + programming. +

      + You can read the documentation that explains how you can replace this feature by the usage of custom worker + pools or {@code executeBlocking} calls.

      +
      +
      +
      deprecated
      +

      as of 3.6.0

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        multiThreaded: boolean
        +
        +

        true for multi-threaded worker, false otherwise

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWorker

    + +
      +
    • + +
      +
      +

      Set whether the verticle(s) should be deployed as a worker verticle

      +
      +
      +

      Parameters

      +
        +
      • +
        worker: boolean
        +
        +

        true for worker, false otherwise

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWorkerPoolName

    + +
      +
    • + +
      +
      +

      Set the worker pool name to use for this verticle. When no name is set, the Vert.x + worker pool will be used, when a name is set, the verticle will use a named worker pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        workerPoolName: string
        +
        +

        the worker pool name

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWorkerPoolSize

    + +
      +
    • + +
      +
      +

      Set the maximum number of worker threads to be used by the Vert.x instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        workerPoolSize: number
        +
        +

        the number of threads

        +
        +
        • +
      +

      Returns DeploymentOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -367,38 +873,80 @@

    workerPoolSize

  • DeploymentOptions
    • diff --git a/docs/@vertx/core/classes/dnsclient.html b/docs/@vertx/core/classes/dnsclient.html index d96b84e60..747c5991d 100644 --- a/docs/@vertx/core/classes/dnsclient.html +++ b/docs/@vertx/core/classes/dnsclient.html @@ -108,12 +108,12 @@

    lookup

  • -

    Try to lookup the A (ipv4) or AAAA (ipv6) record for the given name. The first found will be used.

    +

    Try to lookup the A (ipv4) or AAAA (ipv6) record for the given name. The first found will be used.

    Parameters

    @@ -134,17 +134,20 @@
    handler: function
      • @@ -166,12 +169,12 @@

      lookup4

    • -

      Try to lookup the A (ipv4) record for the given name. The first found will be used.

      +

      Try to lookup the A (ipv4) record for the given name. The first found will be used.

      Parameters

      @@ -185,24 +188,27 @@
      name: string
    • handler: function
      -

      the {@link Handler} to notify with the {@link io.vertx.core.AsyncResult}. +

      the Handler to notify with the {@link io.vertx.core.AsyncResult}. The handler will get notified with the resolved {@link java.net.Inet4Address} if a record was found. If non was found it will get notifed with {@code null}. If an error accours it will get failed.

        • @@ -224,12 +230,12 @@

        lookup6

      • -

        Try to lookup the AAAA (ipv6) record for the given name. The first found will be used.

        +

        Try to lookup the AAAA (ipv6) record for the given name. The first found will be used.

        Parameters

        @@ -243,24 +249,27 @@
        name: string
      • handler: function
        -

        the {@link Handler} to notify with the AsyncResult. The handler will get +

        the Handler to notify with the AsyncResult. The handler will get notified with the resolved {@link java.net.Inet6Address} if a record was found. If non was found it will get notifed with {@code null}. If an error accours it will get failed.

          • @@ -282,12 +291,12 @@

          resolveA

        • -

          Try to resolve all A (ipv4) records for the given name.

          +

          Try to resolve all A (ipv4) records for the given name.

          Parameters

          @@ -309,17 +318,20 @@
          handler: function
            • @@ -341,12 +353,12 @@

            resolveAAAA

          • -

            Try to resolve all AAAA (ipv6) records for the given name.

            +

            Try to resolve all AAAA (ipv6) records for the given name.

            Parameters

            @@ -368,17 +380,20 @@
            handler: function
              • @@ -400,12 +415,12 @@

              resolveCNAME

            • -

              Try to resolve the CNAME record for the given name.

              +

              Try to resolve the CNAME record for the given name.

              Parameters

              @@ -419,24 +434,27 @@
              name: string
            • handler: function
              -

              the {@link Handler} to notify with the AsyncResult. The handler will get +

              the Handler to notify with the AsyncResult. The handler will get notified with the resolved {@link String} if a record was found. If none was found it will get notified with {@code null}. If an error accours it will get failed.

                • @@ -458,12 +476,12 @@

                resolveMX

              • -

                Try to resolve the MX records for the given name.

                +

                Try to resolve the MX records for the given name.

                Parameters

                @@ -485,17 +503,20 @@
                handler: function
                  • @@ -517,12 +538,12 @@

                  resolveNS

                • -

                  Try to resolve the NS records for the given name.

                  +

                  Try to resolve the NS records for the given name.

                  Parameters

                  @@ -536,24 +557,27 @@
                  name: string
                • handler: function
                  -

                  the {@link Handler} to notify with the AsyncResult. The handler will get +

                  the Handler to notify with the AsyncResult. The handler will get notified with a List that contains all resolved {@link String}s. If none was found it will get notified with an empty {@link java.util.List}. If an error accours it will get failed.

                    • @@ -575,12 +599,12 @@

                    resolvePTR

                  • -

                    Try to resolve the PTR record for the given name.

                    +

                    Try to resolve the PTR record for the given name.

                    Parameters

                    @@ -594,24 +618,27 @@
                    name: string
                  • handler: function
                    -

                    the {@link Handler} to notify with the AsyncResult. The handler will get +

                    the Handler to notify with the AsyncResult. The handler will get notified with the resolved {@link String} if a record was found. If none was found it will get notified with {@code null}. If an error accours it will get failed.

                      • @@ -633,12 +660,12 @@

                      resolveSRV

                    • -

                      Try to resolve the SRV records for the given name.

                      +

                      Try to resolve the SRV records for the given name.

                      Parameters

                      @@ -652,24 +679,27 @@
                      name: string
                    • handler: function
                      -

                      the {@link Handler} to notify with the AsyncResult. The handler will get +

                      the Handler to notify with the AsyncResult. The handler will get notified with a List that contains all resolved SrvRecords. If none was found it will get notified with an empty {@link java.util.List}. If an error accours it will get failed.

                        • @@ -691,12 +721,12 @@

                        resolveTXT

                      • -

                        Try to resolve the TXT records for the given name.

                        +

                        Try to resolve the TXT records for the given name.

                        Parameters

                        @@ -710,24 +740,27 @@
                        name: string
                      • handler: function
                        -

                        the {@link Handler} to notify with the AsyncResult. The handler will get +

                        the Handler to notify with the AsyncResult. The handler will get notified with a List that contains all resolved {@link String}s. If none was found it will get notified with an empty {@link java.util.List}. If an error accours it will get failed.

                          • @@ -749,12 +782,12 @@

                          reverseLookup

                        • -

                          Try to do a reverse lookup of an IP address. This is basically the same as doing trying to resolve a PTR record +

                          Try to do a reverse lookup of an IP address. This is basically the same as doing trying to resolve a PTR record but allows you to just pass in the IP address and not a valid ptr query string.

                          @@ -769,24 +802,27 @@
                          ipaddress: string
                        • handler: function
                          -

                          the {@link Handler} to notify with the AsyncResult. The handler will get +

                          the Handler to notify with the AsyncResult. The handler will get notified with the resolved {@link String} if a record was found. If none was found it will get notified with {@code null}. If an error accours it will get failed.

    • -

    Properties

    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the host name to be used by this client in requests.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port to be used by this client in requests.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the host name to be used by this client in requests.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    queryTimeout

    -
    queryTimeout: number
    - -
    -
    -

    Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

    -
    -
    -
    param
    -

    the query timeout in milliseconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port to be used by this client in requests.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getQueryTimeout

    +
      +
    • getQueryTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isRecursionDesired

    +
      +
    • isRecursionDesired(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether or not recursion is desired

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set the host name to be used by this client in requests.

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns DnsClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        +

        true for logging the network activity

        +
        +
        • +
      +

      Returns DnsClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the port to be used by this client in requests.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        • +
      +

      Returns DnsClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setQueryTimeout

    + +
      +
    • + +
      +
      +

      Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.

      +
      +
      +

      Parameters

      +
        +
      • +
        queryTimeout: number
        +
        +

        the query timeout in milliseconds

        +
        +
        • +
      +

      Returns DnsClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRecursionDesired

    + +
      +
    • + +
      +
      +

      Set whether or not recursion is desired

      +
      +
      +

      Parameters

      +
        +
      • +
        recursionDesired: boolean
        +
        +

        the new value

        +
        +
        • +
      +

      Returns DnsClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -169,14 +423,38 @@

    queryTimeout

  • DnsClientOptions
    • diff --git a/docs/@vertx/core/classes/eventbus.html b/docs/@vertx/core/classes/eventbus.html index 9a3abca9f..1cdb35d8c 100644 --- a/docs/@vertx/core/classes/eventbus.html +++ b/docs/@vertx/core/classes/eventbus.html @@ -72,6 +72,12 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -79,15 +85,17 @@

    Index

    Methods

    @@ -95,24 +103,30 @@

    Methods

    Methods

    -
    - -

    addInterceptor

    - @@ -113,12 +121,12 @@

    bodyHandler

  • -

    Convenience method for receiving the entire request body in one piece. +

    Convenience method for receiving the entire request body in one piece.

    This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

    @@ -134,17 +142,20 @@
    bodyHandler: function
      • @@ -165,7 +176,7 @@

      cookies

    • @@ -185,12 +196,12 @@

      customFrameHandler

    • -

      Set an custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 +

      Set an custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.

      @@ -201,17 +212,20 @@
      handler: function
        • @@ -233,7 +247,7 @@

        endHandler

      • Parameters

        @@ -243,17 +257,19 @@
        endHandler: function
          • -
          • (result: void): void | null | undefined
            • +
          • (res: void): void | Handler<void> | null | undefined

          • Parameters

            • -
              result: void
              +
              res: void

            Returns void + | + Handler<void> | null | @@ -279,7 +295,7 @@

            exceptionHandler

          • Parameters

            @@ -289,17 +305,19 @@
            handler: function
              • -
              • (result: Error): void | null | undefined
                • +
              • (res: Error): void | Handler<Error> | null | undefined

              • Parameters

                • -
                  result: Error
                  +
                  res: Error

                Returns void + | + Handler<Error> | null | @@ -315,6 +333,30 @@

                Returns + +

                fetch

                + + +

    • getHeader

    @@ -325,12 +367,12 @@

    getHeader

  • -

    Return the first header value with the specified name

    +

    Return the first header value with the specified name

    Parameters

    @@ -360,12 +402,12 @@

    getTrailer

  • -

    Return the first trailer value with the specified name

    +

    Return the first trailer value with the specified name

    Parameters

    @@ -395,7 +437,7 @@

    handler

  • Parameters

    @@ -405,17 +447,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<Buffer> | null | @@ -441,7 +485,7 @@

        headers

      • @@ -461,17 +505,19 @@

        netSocket

      • -

        Get a net socket for the underlying connection of this request. +

        Get a net socket for the underlying connection of this request.

        - USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol + USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol.

        - One valid use-case for calling this is to receive the {@link io.vertx.core.net.NetSocket} after a HTTP CONNECT was issued to the - remote peer and it responded with a status code of 200.

        + HTTP/1.1 pipe-lined requests cannot support net socket upgrade. +

        + One valid use-case for calling this is to receive the {@link io.vertx.core.net.NetSocket} after a HTTP CONNECT was issued to the + remote peer and it responded with a status code of 200.

        Returns NetSocket

        @@ -488,8 +534,9 @@

        pause

        • Returns HttpClientResponse

          @@ -506,7 +553,7 @@

          request

        • @@ -525,8 +572,9 @@

          resume

          • Returns HttpClientResponse

            @@ -543,7 +591,7 @@

            statusCode

          • @@ -563,7 +611,7 @@

            statusMessage

          • @@ -573,6 +621,60 @@

            Returns string

    • +
    + +

    streamPriorityHandler

    + +
      +
    • + +
      +
      +

      Set an handler for stream priority changes. +

      + This is not implemented for HTTP/1.x.

      +
      +
      +

      Parameters

      + +

      Returns HttpClientResponse

      +
      • +
    +

    trailers

    @@ -583,7 +685,7 @@

    trailers

  • @@ -603,7 +705,7 @@

    version

  • @@ -645,6 +747,9 @@

    Returns exceptionHandler

    • +
  • + fetch +
  • getHeader
    • @@ -675,6 +780,9 @@

    Returns statusMessage +
  • + streamPriorityHandler +
  • trailers
    • diff --git a/docs/@vertx/core/classes/httpconnection.html b/docs/@vertx/core/classes/httpconnection.html index 7797abd2e..be724f0b6 100644 --- a/docs/@vertx/core/classes/httpconnection.html +++ b/docs/@vertx/core/classes/httpconnection.html @@ -115,12 +115,12 @@

    close

  • -

    Close the connection and all the currently active streams. +

    Close the connection and all the currently active streams.

    An HTTP/2 connection will send a {@literal GOAWAY} frame before.

    @@ -139,12 +139,12 @@

    closeHandler

  • -

    Set a close handler. The handler will get notified when the connection is closed.

    +

    Set a close handler. The handler will get notified when the connection is closed.

    Parameters

    @@ -157,17 +157,20 @@
    handler: function
    • +
    +

    Implements

    + +

    Index

    @@ -106,12 +112,12 @@

    actualPort

  • -

    The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number +

    The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port

    @@ -131,12 +137,12 @@

    close

  • -

    Close the server. Any open HTTP connections will be closed. +

    Close the server. Any open HTTP connections will be closed.

    The close happens asynchronously and the server may not be closed until some time after the call has returned.

    @@ -146,12 +152,12 @@

    Returns void
    -

    Like {@link #close} but supplying a handler that will be called when the server is actually closed (or has failed).

    +

    Like {@link #close} but supplying a handler that will be called when the server is actually closed (or has failed).

    Parameters

    @@ -164,17 +170,20 @@
    completionHandler: function
      • @@ -195,12 +204,12 @@

      connectionHandler

    • -

      Set a connection handler for the server.

      +

      Set a connection handler for the server.

      Parameters

      @@ -210,17 +219,20 @@
      handler: function
        • @@ -242,12 +254,12 @@

        exceptionHandler

      • -

        Set an exception handler called for socket errors happening before the HTTP connection +

        Set an exception handler called for socket errors happening before the HTTP connection is established, e.g during the TLS handshake.

        @@ -261,17 +273,20 @@
        handler: function
          • -
          • (result: Error): void
            • +
          • (res: Error): void | Handler<Error>

          • Parameters

            • -
              result: Error
              +
              res: Error
            -

            Returns void

            +

            Returns void + | + Handler<Error> +

          • @@ -292,17 +307,23 @@

          isMetricsEnabled

          • -

            Whether the metrics are enabled for this measured object

            +

            Whether the metrics are enabled for this measured object

            +
            +
            implspec
            +

            The default implementation returns {@code false}

            +
            +

            Returns boolean

            -

            true if the metrics are enabled

            +

            if metrics are enabled

    • @@ -313,6 +334,7 @@

    listen

  • listen(): HttpServer
  • listen(port: number, host: string): HttpServer
  • listen(port: number, host: string, listenHandler: function): HttpServer
    • +
  • listen(address: SocketAddress, listenHandler: function): HttpServer
  • listen(port: number): HttpServer
  • listen(port: number, listenHandler: function): HttpServer
  • listen(listenHandler: function): HttpServer
    • @@ -321,12 +343,12 @@

    listen

  • -

    Tell the server to start listening. The server will listen on the port and host specified in the +

    Tell the server to start listening. The server will listen on the port and host specified in the {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.

    The listen happens asynchronously and the server may not be listening until some time after the call has returned.

    @@ -338,12 +360,12 @@

    Returns
    -

    Tell the server to start listening. The server will listen on the port and host specified here, +

    Tell the server to start listening. The server will listen on the port and host specified here, ignoring any value set in the {@link io.vertx.core.http.HttpServerOptions} that was used when creating the server.

    The listen happens asynchronously and the server may not be listening until some time after the call has returned.

    @@ -370,12 +392,12 @@

    Returns
    -

    Like {@link #listen(int, String)} but supplying a handler that will be called when the server is actually +

    Like {@link #listen(int, String)} but supplying a handler that will be called when the server is actually listening (or has failed).

    @@ -401,17 +423,71 @@
    listenHandler: function
     +

    • + +

    Returns HttpServer

    + +
  • + +
    +
    +

    Tell the server to start listening on the given address supplying + a handler that will be called when the server is actually + listening (or has failed).

    +
    +
    +

    Parameters

    +
    • +
    +

    Implements

    + +

    Index

    @@ -84,6 +90,7 @@

    Methods

  • contentType
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • filename
  • handler
  • isSizeAvailable
    • @@ -109,7 +116,7 @@

    charset

  • @@ -129,7 +136,7 @@

    contentTransferEncoding

  • @@ -149,7 +156,7 @@

    contentType

  • @@ -169,7 +176,7 @@

    endHandler

  • Parameters

    @@ -179,17 +186,19 @@
    endHandler: function
      • -
      • (result: void): void | null | undefined
        • +
      • (res: void): void | Handler<void> | null | undefined

      • Parameters

        • -
          result: void
          +
          res: void

        Returns void + | + Handler<void> | null | @@ -215,7 +224,7 @@

        exceptionHandler

      • Parameters

        @@ -225,17 +234,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -251,6 +262,30 @@

            Returns

    • +
    + +

    fetch

    + + +

    filename

    @@ -261,7 +296,7 @@

    filename

  • @@ -281,7 +316,7 @@

    handler

  • Parameters

    @@ -291,17 +326,19 @@
    handler: function
    • -

    Properties

    -
    - -

    acceptBacklog

    -
    acceptBacklog: number
    - -
    -
    -

    Set the accept back log

    -
    -
    -
    param
    -

    accept backlog

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    acceptUnmaskedFrames

    -
    acceptUnmaskedFrames: boolean
    - -
    -
    -

    Set true when the server accepts unmasked frame. - As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true - It's set to false as default.

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    alpnVersions

    -
    alpnVersions: HttpVersion
    - -
    -
    -

    Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.

    -
    -
    -
    param
    -

    the versions

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clientAuth

    -
    clientAuth: ClientAuth
    - -
    -
    -

    Set whether client auth is required

    -
    -
    -
    param
    -

    One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the - SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then - it won't mandate the certificate to be presented, basically make it optional.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clientAuthRequired

    -
    clientAuthRequired: boolean
    - -
    -
    -

    Set whether client auth is required

    -
    -
    -
    param
    -

    true if client auth is required

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        +

        the SSL/TLS protocols to enable

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    compressionLevel

    -
    compressionLevel: number
    - -
    -
    -

    This method allows to set the compression level to be used in http1.x/2 response bodies - when compression support is turned on (@see setCompressionSupported) and the client advertises - to support {@code deflate/gzip} compression in the {@code Accept-Encoding} header

    -
    -

    default value is : 6 (Netty legacy)

    -

    The compression level determines how much the data is compressed on a scale from 1 to 9, - where '9' is trying to achieve the maximum compression ratio while '1' instead is giving - priority to speed instead of compression ratio using some algorithm optimizations and skipping - pedantic loops that usually gives just little improvements

    -

    While one can think that best value is always the maximum compression ratio, - there's a trade-off to consider: the most compressed level requires the most - computational work to compress/decompress data, e.g. more dictionary lookups and loops.

    -

    E.g. you have it set fairly high on a high-volume website, you may experience performance degradation - and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side - while decompressing - setting an higher compression level can result in an overall higher page load time - especially nowadays when many clients are handled mobile devices with a low CPU profile.

    -

    see also: http://www.gzip.org/algorithm.txt

    -
    -
    param
    -

    integer 1-9, 1 means use fastest algorithm, 9 slower algorithm but better compression ratio

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getAcceptBacklog

    +
      +
    • getAcceptBacklog(): number
      • +
    +
      +
    • + +
      +
      +

      Set the accept back log

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    compressionSupported

    -
    compressionSupported: boolean
    - -
    -
    -

    Set whether the server should support gzip/deflate compression - (serving compressed responses to clients advertising support for them with Accept-Encoding header)

    -
    -
    -
    param
    -

    true to enable compression support

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getAlpnVersions

    + +
      +
    • + +
      +
      +

      Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.

      +
      +
      +

      Returns HttpVersion

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - -
    -
    -

    Add a CRL path

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    getClientAuth

    + +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Returns ClientAuth

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - -
    -
    -

    Add a CRL value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    getCompressionLevel

    +
      +
    • getCompressionLevel(): number
      • +
    +
      +
    • + +
      +
      +

      This method allows to set the compression level to be used in http1.x/2 response bodies + when compression support is turned on (@see setCompressionSupported) and the client advertises + to support {@code deflate/gzip} compression in the {@code Accept-Encoding} header

      +
      +

      default value is : 6 (Netty legacy)

      +

      The compression level determines how much the data is compressed on a scale from 1 to 9, + where '9' is trying to achieve the maximum compression ratio while '1' instead is giving + priority to speed instead of compression ratio using some algorithm optimizations and skipping + pedantic loops that usually gives just little improvements

      +

      While one can think that best value is always the maximum compression ratio, + there's a trade-off to consider: the most compressed level requires the most + computational work to compress/decompress data, e.g. more dictionary lookups and loops.

      +

      E.g. you have it set fairly high on a high-volume website, you may experience performance degradation + and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side + while decompressing - setting an higher compression level can result in an overall higher page load time + especially nowadays when many clients are handled mobile devices with a low CPU profile.

      +

      see also: http://www.gzip.org/algorithm.txt

      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    decoderInitialBufferSize

    -
    decoderInitialBufferSize: number
    - -
    -
    -

    Set the initial buffer size for the HTTP decoder

    -
    -
    -
    param
    -

    the initial size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    decompressionSupported

    -
    decompressionSupported: boolean
    - -
    -
    -

    Set whether the server supports decompression

    -
    -
    -
    param
    -

    true if decompression supported

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlValues

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - -
    -
    -

    Add an enabled cipher suite, appended to the ordered suites.

    -
    -
    -
    param
    -

    the suite

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDecoderInitialBufferSize

    +
      +
    • getDecoderInitialBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the initial buffer size for the HTTP decoder

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - -
    -
    -

    Sets the list of enabled SSL/TLS protocols.

    -
    -
    -
    param
    -

    the SSL/TLS protocols to enable

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    handle100ContinueAutomatically

    -
    handle100ContinueAutomatically: boolean
    - -
    -
    -

    Set whether 100 Continue should be handled automatically

    -
    -
    -
    param
    -

    true if it should be handled automatically

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the host

    -
    -
    -
    param
    -

    the host

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the host

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    http2ConnectionWindowSize

    -
    http2ConnectionWindowSize: number
    - -
    -
    -

    Set the default HTTP/2 connection window size. It overrides the initial window - size set by {@link Http2Settings#getInitialWindowSize}, so the connection window size - is greater than for its streams, in order the data throughput. -

    - A value of {@code -1} reuses the initial window size setting.

    -
    -
    -
    param
    -

    the window size applied to the connection

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHttp2ConnectionWindowSize

    +
      +
    • getHttp2ConnectionWindowSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the default HTTP/2 connection window size. It overrides the initial window + size set by {@link Http2Settings#getInitialWindowSize}, so the connection window size + is greater than for its streams, in order the data throughput. +

      + A value of {@code -1} reuses the initial window size setting.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - -
    -
    -

    Set the idle timeout, in seconds. zero means don't timeout. - This determines if a connection will timeout and be closed if no data is received within the timeout.

    -
    -
    -
    param
    -

    the timeout, in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +

      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    initialSettings

    -
    initialSettings: Http2Settings
    - -
    -
    -

    Set the HTTP/2 connection settings immediatly sent by the server when a client connects.

    -
    -
    -
    param
    -

    the settings value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getInitialSettings

    + +
      +
    • + +
      +
      +

      Set the HTTP/2 connection settings immediatly sent by the server when a client connects.

      +
      +
      +

      Returns Http2Settings

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - -
    -
    -

    Set the key/cert options in jks format, aka Java keystore.

    -
    -
    -
    param
    -

    the key store in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getJdkSslEngineOptions

    + +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - -
    -
    -

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    -
    -
    -
    param
    -

    true for logging the network activity

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxChunkSize

    -
    maxChunkSize: number
    - -
    -
    -

    Set the maximum HTTP chunk size

    -
    -
    -
    param
    -

    the maximum chunk size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxHeaderSize

    -
    maxHeaderSize: number
    - -
    -
    -

    Set the maximum length of all headers for HTTP/1.x .

    -
    -
    -
    param
    -

    the new maximum length

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxChunkSize

    +
      +
    • getMaxChunkSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum HTTP chunk size that {@link HttpServerRequest#handler(Handler)} will receive

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxInitialLineLength

    -
    maxInitialLineLength: number
    - -
    -
    -

    Set the maximum length of the initial line for HTTP/1.x (e.g. {@code "GET / HTTP/1.0"})

    -
    -
    -
    param
    -

    the new maximum initial length

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxHeaderSize

    +
      +
    • getMaxHeaderSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum length of all headers for HTTP/1.x .

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWebsocketFrameSize

    -
    maxWebsocketFrameSize: number
    - -
    -
    -

    Set the maximum websocket frames size

    -
    -
    -
    param
    -

    the maximum frame size in bytes.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxInitialLineLength

    +
      +
    • getMaxInitialLineLength(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum length of the initial line for HTTP/1.x (e.g. {@code "GET / HTTP/1.0"})

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWebsocketMessageSize

    -
    maxWebsocketMessageSize: number
    - -
    -
    -

    Set the maximum websocket message size

    -
    -
    -
    param
    -

    the maximum message size in bytes.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxWebsocketFrameSize

    +
      +
    • getMaxWebsocketFrameSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum websocket frames size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getMaxWebsocketMessageSize

    +
      +
    • getMaxWebsocketMessageSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum websocket message size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - -
    -
    -

    Set the key/cert store options in pem format.

    -
    -
    -
    param
    -

    the options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getOpenSslEngineOptions

    + + +
    +
    + +

    getPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pem format

      +
      +
      +

      Returns PemTrustOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWebsocketAllowServerNoContext

    +
      +
    • getWebsocketAllowServerNoContext(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the WebSocket Allow Server No Context option

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWebsocketPreferredClientNoContext

    +
      +
    • getWebsocketPreferredClientNoContext(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the WebSocket Preferred Client No Context setting

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWebsocketSubProtocols

    +
      +
    • getWebsocketSubProtocols(): string
      • +
    +
      +
    • + +
      +
      +

      Set the websocket subprotocols supported by the server.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isAcceptUnmaskedFrames

    +
      +
    • isAcceptUnmaskedFrames(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set true when the server accepts unmasked frame. + As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true + It's set to false as default.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isClientAuthRequired

    +
      +
    • isClientAuthRequired(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isCompressionSupported

    +
      +
    • isCompressionSupported(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the server should support gzip/deflate compression + (serving compressed responses to clients advertising support for them with Accept-Encoding header)

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isDecompressionSupported

    +
      +
    • isDecompressionSupported(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the server supports decompression

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isHandle100ContinueAutomatically

    +
      +
    • isHandle100ContinueAutomatically(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether 100 Continue should be handled automatically

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSni

    +
      +
    • isSni(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the server supports Server Name Indiciation

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +
      deprecated
      +

      this has no effect, just don't use it

      +
      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    perFrameWebsocketCompressionSupported

    +
      +
    • perFrameWebsocketCompressionSupported(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable or disable support for WebSocket Defalte Frame compression

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    perMessageWebsocketCompressionSupported

    +
      +
    • perMessageWebsocketCompressionSupported(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable or disable support for WebSocket Permessage Deflate compression

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAcceptBacklog

    + +
      +
    • + +
      +
      +

      Set the accept back log

      +
      +
      +

      Parameters

      +
        +
      • +
        acceptBacklog: number
        +
        +

        accept backlog

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAcceptUnmaskedFrames

    + +
      +
    • + +
      +
      +

      Set true when the server accepts unmasked frame. + As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true + It's set to false as default.

      +
      +
      +

      Parameters

      +
        +
      • +
        acceptUnmaskedFrames: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAlpnVersions

    + +
      +
    • + +
      +
      +

      Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClientAuth

    + +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Parameters

      +
        +
      • +
        clientAuth: ClientAuth
        +
        +

        One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the + SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then + it won't mandate the certificate to be presented, basically make it optional.

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClientAuthRequired

    + +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Parameters

      +
        +
      • +
        clientAuthRequired: boolean
        +
        +

        true if client auth is required

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCompressionLevel

    + +
      +
    • + +
      +
      +

      This method allows to set the compression level to be used in http1.x/2 response bodies + when compression support is turned on (@see setCompressionSupported) and the client advertises + to support {@code deflate/gzip} compression in the {@code Accept-Encoding} header

      +
      +

      default value is : 6 (Netty legacy)

      +

      The compression level determines how much the data is compressed on a scale from 1 to 9, + where '9' is trying to achieve the maximum compression ratio while '1' instead is giving + priority to speed instead of compression ratio using some algorithm optimizations and skipping + pedantic loops that usually gives just little improvements

      +

      While one can think that best value is always the maximum compression ratio, + there's a trade-off to consider: the most compressed level requires the most + computational work to compress/decompress data, e.g. more dictionary lookups and loops.

      +

      E.g. you have it set fairly high on a high-volume website, you may experience performance degradation + and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side + while decompressing - setting an higher compression level can result in an overall higher page load time + especially nowadays when many clients are handled mobile devices with a low CPU profile.

      +

      see also: http://www.gzip.org/algorithm.txt

      +
      +

      Parameters

      +
        +
      • +
        compressionLevel: number
        +
        +

        integer 1-9, 1 means use fastest algorithm, 9 slower algorithm but better compression ratio

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCompressionSupported

    + +
      +
    • + +
      +
      +

      Set whether the server should support gzip/deflate compression + (serving compressed responses to clients advertising support for them with Accept-Encoding header)

      +
      +
      +

      Parameters

      +
        +
      • +
        compressionSupported: boolean
        +
        +

        true to enable compression support

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDecoderInitialBufferSize

    +
      +
    • setDecoderInitialBufferSize(decoderInitialBufferSize: number): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Set the initial buffer size for the HTTP decoder

      +
      +
      +

      Parameters

      +
        +
      • +
        decoderInitialBufferSize: number
        +
        +

        the initial size

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDecompressionSupported

    + +
      +
    • + +
      +
      +

      Set whether the server supports decompression

      +
      +
      +

      Parameters

      +
        +
      • +
        decompressionSupported: boolean
        +
        +

        true if decompression supported

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        +

        the SSL/TLS protocols to enable

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHandle100ContinueAutomatically

    +
      +
    • setHandle100ContinueAutomatically(handle100ContinueAutomatically: boolean): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Set whether 100 Continue should be handled automatically

      +
      +
      +

      Parameters

      +
        +
      • +
        handle100ContinueAutomatically: boolean
        +
        +

        true if it should be handled automatically

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set the host

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the host

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHttp2ConnectionWindowSize

    +
      +
    • setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Set the default HTTP/2 connection window size. It overrides the initial window + size set by {@link Http2Settings#getInitialWindowSize}, so the connection window size + is greater than for its streams, in order the data throughput. +

      + A value of {@code -1} reuses the initial window size setting.

      +
      +
      +

      Parameters

      +
        +
      • +
        http2ConnectionWindowSize: number
        +
        +

        the window size applied to the connection

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +
      +
      +

      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +

      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

      +
      +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        +

        the timeout, in seconds

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        +

        specify time unit.

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setInitialSettings

    + +
      +
    • + +
      +
      +

      Set the HTTP/2 connection settings immediatly sent by the server when a client connects.

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    + + +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        +

        true for logging the network activity

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxChunkSize

    + +
      +
    • + +
      +
      +

      Set the maximum HTTP chunk size that {@link HttpServerRequest#handler(Handler)} will receive

      +
      +
      +

      Parameters

      +
        +
      • +
        maxChunkSize: number
        +
        +

        the maximum chunk size

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxHeaderSize

    + +
      +
    • + +
      +
      +

      Set the maximum length of all headers for HTTP/1.x .

      +
      +
      +

      Parameters

      +
        +
      • +
        maxHeaderSize: number
        +
        +

        the new maximum length

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxInitialLineLength

    + +
      +
    • + +
      +
      +

      Set the maximum length of the initial line for HTTP/1.x (e.g. {@code "GET / HTTP/1.0"})

      +
      +
      +

      Parameters

      +
        +
      • +
        maxInitialLineLength: number
        +
        +

        the new maximum initial length

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWebsocketFrameSize

    + +
      +
    • + +
      +
      +

      Set the maximum websocket frames size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWebsocketFrameSize: number
        +
        +

        the maximum frame size in bytes.

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWebsocketMessageSize

    + +
      +
    • + +
      +
      +

      Set the maximum websocket message size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWebsocketMessageSize: number
        +
        +

        the maximum message size in bytes.

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    + + +
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pem format

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPerFrameWebsocketCompressionSupported

    +
      +
    • setPerFrameWebsocketCompressionSupported(perFrameWebsocketCompressionSupported: boolean): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Enable or disable support for WebSocket Defalte Frame compression

      +
      +
      +

      Parameters

      +
        +
      • +
        perFrameWebsocketCompressionSupported: boolean
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPerMessageWebsocketCompressionSupported

    +
      +
    • setPerMessageWebsocketCompressionSupported(perMessageWebsocketCompressionSupported: boolean): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Enable or disable support for WebSocket Permessage Deflate compression

      +
      +
      +

      Parameters

      +
        +
      • +
        perMessageWebsocketCompressionSupported: boolean
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the port

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - -
    -
    -

    Set the trust options in pem format

    -
    -
    -
    param
    -

    the trust options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - -
    -
    -

    Set the key/cert options in pfx format.

    -
    -
    -
    param
    -

    the key cert options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReuseAddress

    + +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        +

        the value of reuse address

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - -
    -
    -

    Set the trust options in pfx format

    -
    -
    -
    param
    -

    the trust options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReusePort

    + +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        +

        the value of reuse port

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port

    -
    -
    -
    param
    -

    the port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSendBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - -
    -
    -

    Set the TCP receive buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSni

    + +
      +
    • + +
      +
      +

      Set whether the server supports Server Name Indiciation

      +
      +
      +

      Parameters

      +
        +
      • +
        sni: boolean
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - -
    -
    -

    Set the value of reuse address

    -
    -
    -
    param
    -

    the value of reuse address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSoLinger

    + +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        +

        true if SO_linger is enabled

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - -
    -
    -

    Set the value of reuse port. -

    - This is only supported by native transports.

    -
    -
    -
    param
    -

    the value of reuse port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - -
    -
    -

    Set the TCP send buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpCork

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        +

        the cork value

        +
        +
        • +
      +

      Returns HttpServerOptions

      +
      • +
    -
    - -

    sni

    -
    sni: boolean
    - -
    -
    -

    Set whether the server supports Server Name Indiciation

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        +

        the fast open value

        +
        +
        • +
      +

      Returns HttpServerOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - -
    -
    -

    Set whether SO_linger keep alive is enabled

    -
    -
    -
    param
    -

    true if SO_linger is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        +

        true if TCP keep alive is enabled

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set whether SSL/TLS is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        +

        true if TCP no delay is enabled (Nagle disabled)

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - -
    -
    -

    Enable the {@code TCP_CORK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the cork value

    -
    -
    -
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        +

        the quick ack value

        +
        +
        • +
      +

      Returns HttpServerOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - -
    -
    -

    Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

    -
    -
    -
    param
    -

    the fast open value

    -
    -
    -
    +
    + +

    setTrafficClass

    + +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        +

        the value of traffic class

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - -
    -
    -

    Set whether TCP keep alive is enabled

    -
    -
    -
    param
    -

    true if TCP keep alive is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Parameters

      + +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - -
    -
    -

    Set whether TCP no delay is enabled

    -
    -
    -
    param
    -

    true if TCP no delay is enabled (Nagle disabled)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setUseAlpn

    + +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        +

        true when Application-Layer Protocol Negotiation should be used

        +
        +
        • +
      +

      Returns HttpServerOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - -
    -
    -

    Enable the {@code TCP_QUICKACK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the quick ack value

    -
    -
    -
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +
      deprecated
      +

      this has no effect, just don't use it

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        +

        true if pooled buffers enabled

        +
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - -
    -
    -

    Set the value of traffic class

    -
    -
    -
    param
    -

    the value of traffic class

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketAllowServerNoContext

    +
      +
    • setWebsocketAllowServerNoContext(websocketAllowServerNoContext: boolean): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Set the WebSocket Allow Server No Context option

      +
      +
      +

      Parameters

      +
        +
      • +
        websocketAllowServerNoContext: boolean
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - -
    -
    -

    Set the trust options in jks format, aka Java truststore

    -
    -
    -
    param
    -

    the trust options in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketCompressionLevel

    +
      +
    • setWebsocketCompressionLevel(websocketCompressionLevel: number): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Set the WebSocket compression level

      +
      +
      +

      Parameters

      +
        +
      • +
        websocketCompressionLevel: number
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - -
    -
    -

    Set the ALPN usage.

    -
    -
    -
    param
    -

    true when Application-Layer Protocol Negotiation should be used

    -
    -
    -
    +
    + +

    setWebsocketPreferredClientNoContext

    +
      +
    • setWebsocketPreferredClientNoContext(websocketPreferredClientNoContext: boolean): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      Set the WebSocket Preferred Client No Context setting

      +
      +
      +

      Parameters

      +
        +
      • +
        websocketPreferredClientNoContext: boolean
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - -
    -
    -

    Set whether Netty pooled buffers are enabled

    -
    -
    -
    param
    -

    true if pooled buffers enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketSubProtocols

    + +
      +
    • + +
      +
      +

      Set the websocket subprotocols supported by the server.

      +
      +
      +

      Parameters

      +
        +
      • +
        websocketSubProtocols: string
        +
        • +
      +

      Returns HttpServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    websocketSubProtocols

    -
    websocketSubProtocols: string
    - -
    -
    -

    Set the websocket subprotocols supported by the server.

    -
    -
    -
    param
    -

    comma separated list of subprotocols

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    websocketCompressionLevel

    +
      +
    • websocketCompressionLevel(): number
      • +
    +
      +
    • + +
      +
      +

      Set the WebSocket compression level

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -1271,152 +3307,341 @@

    websocketSubProtocols

  • HttpServerOptions
    • diff --git a/docs/@vertx/core/classes/httpserverrequest.html b/docs/@vertx/core/classes/httpserverrequest.html index 320f56d7b..d1641d982 100644 --- a/docs/@vertx/core/classes/httpserverrequest.html +++ b/docs/@vertx/core/classes/httpserverrequest.html @@ -72,6 +72,12 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -81,10 +87,12 @@

    Methods

    connection

    @@ -206,7 +238,7 @@

    connection

  • @@ -226,12 +258,12 @@

    customFrameHandler

  • -

    Set a custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 +

    Set a custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.

    @@ -242,17 +274,20 @@
    handler: function
      • @@ -274,7 +309,7 @@

      endHandler

    • Parameters

      @@ -284,17 +319,19 @@
      endHandler: function
        • -
        • (result: void): void | null | undefined
          • +
        • (res: void): void | Handler<void> | null | undefined

        • Parameters

          • -
            result: void
            +
            res: void

          Returns void + | + Handler<void> | null | @@ -320,7 +357,7 @@

          exceptionHandler

        • Parameters

          @@ -330,17 +367,19 @@
          handler: function
            • -
            • (result: Error): void | null | undefined
              • +
            • (res: Error): void | Handler<Error> | null | undefined

            • Parameters

              • -
                result: Error
                +
                res: Error

              Returns void + | + Handler<Error> | null | @@ -356,6 +395,30 @@

              Returns + +

              fetch

              + + +

    • formAttributes

    @@ -366,12 +429,12 @@

    formAttributes

  • -

    Returns a map of all form attributes in the request. +

    Returns a map of all form attributes in the request.

    Be aware that the attributes will only be available after the whole body has been received, i.e. after the request end handler has been called. @@ -394,12 +457,12 @@

    getFormAttribute

  • -

    Return the first form attribute value with the specified name

    +

    Return the first form attribute value with the specified name

    Parameters

    @@ -429,12 +492,12 @@

    getHeader

  • -

    Return the first header value with the specified name

    +

    Return the first header value with the specified name

    Parameters

    @@ -464,12 +527,12 @@

    getParam

  • -

    Return the first param value with the specified name

    +

    Return the first param value with the specified name

    Parameters

    @@ -499,7 +562,7 @@

    handler

  • Parameters

    @@ -509,17 +572,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<Buffer> | null | @@ -545,7 +610,7 @@

        headers

      • @@ -565,7 +630,7 @@

        host

      • @@ -588,12 +653,12 @@

        isEnded

      • -

        Has the request ended? I.e. has the entire request, including the body been read?

        +

        Has the request ended? I.e. has the entire request, including the body been read?

        Returns boolean

        @@ -611,7 +676,7 @@

        isExpectMultipart

      • @@ -631,7 +696,7 @@

        isSSL

      • @@ -651,7 +716,7 @@

        localAddress

      • @@ -671,7 +736,7 @@

        method

      • @@ -691,19 +756,44 @@

        netSocket

      • -

        Get a net socket for the underlying connection of this request. -

        - USE THIS WITH CAUTION! -

        - Once you have called this method, you must handle writing to the connection yourself using the net socket, - the server request instance will no longer be usable as normal. - Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol.

        +

        Get a net socket for the underlying connection of this request. +

        + This method must be called before the server response is ended. +

        + With {@code CONNECT} requests, a {@code 200} response is sent with no {@code content-length} header set + before returning the socket. +

        + 

        + server.requestHandler(req -> {
+   if (req.method() == HttpMethod.CONNECT) {
+     // Send a 200 response to accept the connect
+     NetSocket socket = req.netSocket();
+     socket.handler(buff -> {
+       socket.write(buff);
+     });
+   }
+   ...
+ });
+
        +

        + For other HTTP/1 requests once you have called this method, you must handle writing to the connection yourself using + the net socket, the server request instance will no longer be usable as normal. USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're + doing can easily break the HTTP protocol. +

        + With HTTP/2, a {@code 200} response is always sent with no {@code content-length} header set before returning the socket + like in the {@code CONNECT} case above. +

        +
        +
        throws
        +

        IllegalStateException when the socket can't be created

        +
        +

        Returns NetSocket

        the net socket

        @@ -720,7 +810,7 @@

        params

      • @@ -740,7 +830,7 @@

        path

      • @@ -762,8 +852,9 @@

        pause

        • Returns HttpServerRequest

          @@ -780,7 +871,7 @@

          query

        • @@ -803,7 +894,7 @@

          rawMethod

        • @@ -823,7 +914,7 @@

          remoteAddress

        • @@ -843,7 +934,7 @@

          response

        • @@ -863,8 +954,9 @@

          resume

          • Returns HttpServerRequest

            @@ -881,7 +973,7 @@

            scheme

          • @@ -904,12 +996,12 @@

            setExpectMultipart

          • -

            Call this with true if you are expecting a multi-part body to be submitted in the request. +

            Call this with true if you are expecting a multi-part body to be submitted in the request. This must be called before the body of the request has been received

            @@ -927,6 +1019,80 @@

            Returns + +

            streamPriority

            + +
              +
            • + +
              +
              +

              Returns StreamPriority

              +

              the priority of the associated HTTP/2 stream for HTTP/2 otherwise {@code null}

              +
              • +
            +
    • +
    + +

    streamPriorityHandler

    + + +

    upgrade

    @@ -937,12 +1103,12 @@

    upgrade

  • -

    Upgrade the connection to a WebSocket connection. +

    Upgrade the connection to a WebSocket connection.

    This is an alternative way of handling WebSockets and can only be used if no websocket handlers are set on the Http server, and can only be used during the upgrade request during the WebSocket handshake.

    @@ -963,12 +1129,12 @@

    uploadHandler

  • -

    Set an upload handler. The handler will get notified once a new file upload was received to allow you to deal +

    Set an upload handler. The handler will get notified once a new file upload was received to allow you to deal with the file upload.

    @@ -979,17 +1145,19 @@
    uploadHandler: function
    • +
    +

    Implements

    + +

    Index

    @@ -103,6 +109,7 @@

    Methods

  • setChunked
  • setStatusCode
  • setStatusMessage
    • +
  • setStreamPriority
  • setWriteQueueMaxSize
  • streamId
  • trailers
    • @@ -127,12 +134,12 @@

    bodyEndHandler

  • -

    Provides a handler that will be called after the last part of the body is written to the wire. +

    Provides a handler that will be called after the last part of the body is written to the wire. The handler is called asynchronously of when the response has been received by the client. This provides a hook allowing you to do more operations once the request has been sent over the wire such as resource cleanup.

    @@ -148,17 +155,19 @@
    handler: function

    • setWriteQueueMaxSize

    @@ -1437,8 +1511,9 @@

    setWriteQueueMaxSize

    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    -

    Properties

    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Set the password for the key store

    -
    -
    -
    param
    -

    the password

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns JksOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns JksOptions

      +
      • +
    -
    - -

    path

    -
    path: string
    - -
    -
    -

    Set the path to the key store

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Set the password for the key store

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    value

    -
    value: Buffer
    - -
    -
    -

    Set the key store as a buffer

    -
    -
    -
    param
    -

    the key store as a buffer

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPath

    +
      +
    • getPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the path to the key store

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getValue

    + +
      +
    • + +
      +
      +

      Set the key store as a buffer

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Set the password for the key store

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        +

        the password

        +
        +
        • +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPath

    + +
      +
    • + +
      +
      +

      Set the path to the key store

      +
      +
      +

      Parameters

      +
        +
      • +
        path: string
        +
        +

        the path

        +
        +
        • +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setValue

    + +
      +
    • + +
      +
      +

      Set the key store as a buffer

      +
      +
      +

      Parameters

      +
        +
      • +
        value: Buffer
        +
        +

        the key store as a buffer

        +
        +
        • +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -175,14 +315,26 @@

    value

  • JksOptions
    • diff --git a/docs/@vertx/core/classes/jsonevent.html b/docs/@vertx/core/classes/jsonevent.html index de0055089..71522e740 100644 --- a/docs/@vertx/core/classes/jsonevent.html +++ b/docs/@vertx/core/classes/jsonevent.html @@ -93,7 +93,7 @@

    Methods

  • isObject
  • isString
  • longValue
    • -
  • mapTo
    • +
  • mapTo
  • objectValue
  • stringValue
  • type
    • @@ -115,7 +115,7 @@

    arrayValue

  • @@ -140,12 +140,12 @@

    binaryValue

  • -

    Return the binary value. +

    Return the binary value.

    JSON itself has no notion of a binary, this extension complies to the RFC-7493, so this method assumes there is a String value with the key and it contains a Base64 encoded binary, which it decodes if found and returns.

    @@ -174,7 +174,7 @@

    booleanValue

  • @@ -199,7 +199,7 @@

    doubleValue

  • @@ -224,7 +224,7 @@

    fieldName

  • @@ -244,7 +244,7 @@

    floatValue

  • @@ -269,7 +269,7 @@

    integerValue

  • @@ -294,7 +294,7 @@

    isArray

  • @@ -314,7 +314,7 @@

    isBoolean

  • @@ -334,7 +334,7 @@

    isNull

  • @@ -354,7 +354,7 @@

    isNumber

  • @@ -374,7 +374,7 @@

    isObject

  • @@ -394,7 +394,7 @@

    isString

  • @@ -414,7 +414,7 @@

    longValue

  • @@ -429,34 +429,40 @@

    Returns number

    • -
    +

    mapTo

    -
      -
    • mapTo(type: Class): Object
      • +
        +
      • mapTo<T>(type: any): T
      • -

        Decodes and returns the current value as the specified {@code type}.

        +

        Decodes and returns the current value as the specified {@code type}.

        +

        Type parameters

        +
          +
        • +

          T

          +
          • +

        Parameters

        • -
          type: Class
          +
          type: any

          the type to decode the value to

        -

        Returns Object

        +

        Returns T

        the decoded value

      @@ -471,7 +477,7 @@

      objectValue

    • @@ -483,6 +489,11 @@

      objectValue

      Returns object

      the JSON object value or {@code null} if the event has no JSON value

      +
        +
      • +
        [key: string]: any
        +
        • +
    @@ -496,7 +507,7 @@

    stringValue

  • @@ -521,7 +532,7 @@

    type

  • @@ -535,18 +546,18 @@

    Returns

    value

      -
    • value(): Object
      • +
    • value(): any
    • -

      Returns Object

      +

      Returns any

      the json value for {@link JsonEventType#VALUE} events

    @@ -610,7 +621,7 @@

    Returns Object longValue

    • -
  • +
  • mapTo
  • diff --git a/docs/@vertx/core/classes/jsonparser.html b/docs/@vertx/core/classes/jsonparser.html index 6d1dfed1e..5a30e1c35 100644 --- a/docs/@vertx/core/classes/jsonparser.html +++ b/docs/@vertx/core/classes/jsonparser.html @@ -72,6 +72,13 @@

    Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -84,6 +91,7 @@

    Methods

  • end
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • handle
  • handler
  • objectEventMode
    • @@ -109,12 +117,12 @@

    arrayEventMode

  • -

    Flip the parser to emit a stream of events for each new json array.

    +

    Flip the parser to emit a stream of events for each new json array.

    Returns JsonParser

    @@ -132,12 +140,12 @@

    arrayValueMode

  • -

    Flip the parser to emit a single value event for each new json array. +

    Flip the parser to emit a single value event for each new json array.

    Json array currently streamed won't be affected.

    @@ -157,12 +165,12 @@

    end

  • -

    End the stream, this must be called after all the json stream has been processed.

    +

    End the stream, this must be called after all the json stream has been processed.

    Returns void

    @@ -179,7 +187,7 @@

    endHandler

  • Parameters

    @@ -189,17 +197,19 @@
    endHandler: function
      • -
      • (result: void): void | null | undefined
        • +
      • (res: void): void | Handler<void> | null | undefined

      • Parameters

        • -
          result: void
          +
          res: void

        Returns void + | + Handler<void> | null | @@ -225,7 +235,7 @@

        exceptionHandler

      • Parameters

        @@ -235,17 +245,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -261,6 +273,30 @@

            Returns + +

            fetch

            + +
              +
            • + +

              Parameters

              +
                +
              • +
                amount: number
                +
                • +
              +

              Returns JsonParser

              +
              • +
            +

    • handle

    @@ -271,12 +307,12 @@

    handle

  • -

    Something has happened, so handle it.

    +

    Something has happened, so handle it.

    Parameters

    @@ -302,7 +338,7 @@

    handler

  • Parameters

    @@ -312,17 +348,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<JsonEvent> | null | @@ -348,12 +386,12 @@

        objectEventMode

      • -

        Flip the parser to emit a stream of events for each new json object.

        +

        Flip the parser to emit a stream of events for each new json object.

        Returns JsonParser

        @@ -371,12 +409,12 @@

        objectValueMode

      • -

        Flip the parser to emit a single value event for each new json object. +

        Flip the parser to emit a single value event for each new json object.

        Json object currently streamed won't be affected.

        @@ -395,8 +433,9 @@

        pause

        +
        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +
        +

        Hierarchy

          @@ -110,12 +121,12 @@

          clear

        • -

          Clear all entries in the map

          +

          Clear all entries in the map

          Returns void

          @@ -132,12 +143,12 @@

          close

        • -

          Close and release the map

          +

          Close and release the map

          Returns void

          @@ -154,12 +165,12 @@

          containsKey

        • -

          Returns {@code true} if this map contains a mapping for the specified +

          Returns {@code true} if this map contains a mapping for the specified key.

          @@ -187,12 +198,12 @@

          containsValue

        • -

          Returns @{code true} if this map maps one or more keys to the +

          Returns @{code true} if this map maps one or more keys to the specified value.

          @@ -214,18 +225,18 @@

          Returns boolean

          get

            -
          • get(key: any): Object
            • +
          • get(key: any): V
          • -

            Get a value from the map

            +

            Get a value from the map

            Parameters

            @@ -237,7 +248,7 @@
            key: any

      -

      Returns Object

      +

      Returns V

      the value, or null if none

    @@ -246,18 +257,18 @@

    Returns Object

    getOrDefault

      -
    • getOrDefault(key: any, defaultValue: any): Object
      • +
    • getOrDefault(key: any, defaultValue: V): V
    • -

      Returns the value to which the specified key is mapped, or +

      Returns the value to which the specified key is mapped, or {@code defaultValue} if this map contains no mapping for the key.

      @@ -270,13 +281,13 @@
      key: any
    • -
      defaultValue: any
      +
      defaultValue: V

      the default mapping of the key

    -

    Returns Object

    +

    Returns V

    the value to which the specified key is mapped, or {@code defaultValue} if this map contains no mapping for the key

    • @@ -292,7 +303,7 @@

    isEmpty

  • @@ -306,36 +317,36 @@

    Returns boolean

    put

      -
    • put(key: any, value: any): Object
      • +
    • put(key: K, value: V): V
    • -

      Put an entry in the map

      +

      Put an entry in the map

      Parameters

      • -
        key: any
        +
        key: K

        the key

      • -
        value: any
        +
        value: V

        the value

      -

      Returns Object

      +

      Returns V

      return the old value, or null if none

    @@ -344,36 +355,36 @@

    Returns Object

    putIfAbsent

      -
    • putIfAbsent(key: any, value: any): Object
      • +
    • putIfAbsent(key: K, value: V): V
    • -

      Put the entry only if there is no existing entry for that key

      +

      Put the entry only if there is no existing entry for that key

      Parameters

      • -
        key: any
        +
        key: K

        the key

      • -
        value: any
        +
        value: V

        the value

      -

      Returns Object

      +

      Returns V

      the old value or null, if none

    @@ -382,18 +393,18 @@

    Returns Object

    remove

      -
    • remove(key: any): Object
      • +
    • remove(key: any): V
    • -

      Remove an entry from the map

      +

      Remove an entry from the map

      Parameters

      @@ -405,7 +416,7 @@
      key: any

    • -

    Returns Object

    +

    Returns V

    the old value

    @@ -414,18 +425,18 @@

    Returns Object

    removeIfPresent

      -
    • removeIfPresent(key: any, value: any): boolean
      • +
    • removeIfPresent(key: K, value: V): boolean
    • -

      Remove the entry only if there is an entry with the specified key and value. +

      Remove the entry only if there is an entry with the specified key and value.

      This method is the poyglot version of {@link #remove(Object, Object)}.

      @@ -433,13 +444,13 @@

      removeIfPresent

      Parameters

      • -
        key: any
        +
        key: K

        the key

      • -
        value: any
        +
        value: V

        the value

        @@ -454,36 +465,36 @@

        Returns boolean

        replace

          -
        • replace(key: any, value: any): Object
          • +
        • replace(key: K, value: V): V
        • -

          Replace the entry only if there is an existing entry with the key

          +

          Replace the entry only if there is an existing entry with the key

          Parameters

          • -
            key: any
            +
            key: K

            the key

          • -
            value: any
            +
            value: V

            the new value

          -

          Returns Object

          +

          Returns V

          the old value

        @@ -492,18 +503,18 @@

        Returns Object

        replaceIfPresent

          -
        • replaceIfPresent(key: any, oldValue: any, newValue: any): boolean
          • +
        • replaceIfPresent(key: K, oldValue: V, newValue: V): boolean
        • -

          Replace the entry only if there is an existing entry with the specified key and value. +

          Replace the entry only if there is an existing entry with the specified key and value.

          This method is the polyglot version of {@link #replace(Object, Object, Object)}.

          @@ -511,19 +522,19 @@

          replaceIfPresent

          Parameters

          • -
            key: any
            +
            key: K

            the key

          • -
            oldValue: any
            +
            oldValue: V

            the old value

          • -
            newValue: any
            +
            newValue: V

            the new value

            @@ -544,12 +555,12 @@

            size

          • -

            Get the size of the map

            +

            Get the size of the map

            Returns number

            @@ -571,7 +582,7 @@

            Returns number

            -
          • +
          • LocalMap
            • diff --git a/docs/@vertx/core/classes/lock.html b/docs/@vertx/core/classes/lock.html index d21d188aa..ad1151bd8 100644 --- a/docs/@vertx/core/classes/lock.html +++ b/docs/@vertx/core/classes/lock.html @@ -97,12 +97,12 @@

              release

            • -

              Release the lock. Once the lock is released another will be able to obtain the lock.

              +

              Release the lock. Once the lock is released another will be able to obtain the lock.

              Returns void

              diff --git a/docs/@vertx/core/classes/message.html b/docs/@vertx/core/classes/message.html index c2464dc80..fe00b7429 100644 --- a/docs/@vertx/core/classes/message.html +++ b/docs/@vertx/core/classes/message.html @@ -57,13 +57,21 @@ Message
            -

            Class Message

            +

            Class Message<T>

      +
      +

      Type parameters

      +
        +
      • +

        T

        +
        • +
      +

      Hierarchy

      @@ -103,12 +111,12 @@

      address

    • -

      The address the message was sent to

      +

      The address the message was sent to

      Returns string

      @@ -119,21 +127,21 @@

      Returns string

      body

        -
      • body(): Object
        • +
      • body(): T
      • -

        The body of the message. Can be null.

        +

        The body of the message. Can be null.

        -

        Returns Object

        +

        Returns T

        the body, or null.

      @@ -148,12 +156,12 @@

      fail

    • -

      Signal to the sender that processing of this message failed. +

      Signal to the sender that processing of this message failed.

      If the message was sent specifying a result handler the handler will be called with a failure corresponding to the failure code and message specified here.

      @@ -188,12 +196,12 @@

      headers

    • -

      Multi-map of message headers. Can be empty

      +

      Multi-map of message headers. Can be empty

      Returns MultiMap

      @@ -211,12 +219,12 @@

      isSend

    • -

      Signals if this message represents a send or publish event.

      +

      Signals if this message represents a send or publish event.

      Returns boolean

      @@ -224,25 +232,25 @@

      Returns boolean

    -
    +

    reply

    -
      +
      • reply(message: any): void
        • -
      • reply(message: any, replyHandler: function): void
        • +
      • reply<R>(message: any, replyHandler: function): void
      • reply(message: any, options: DeliveryOptions): void
        • -
      • reply(message: any, options: DeliveryOptions, replyHandler: function): void
        • +
      • reply<R>(message: any, options: DeliveryOptions, replyHandler: function): void
      • -

        Reply to this message. +

        Reply to this message.

        If the message was sent specifying a reply handler, that handler will be called when it has received a reply. If the message wasn't sent specifying a receipt handler @@ -263,15 +271,21 @@

        Returns void
        -

        The same as {@code reply(R message)} but you can specify handler for the reply - i.e. +

        The same as {@code reply(R message)} but you can specify handler for the reply - i.e. to receive the reply to the reply.

        +

        Type parameters

        +
          +
        • +

          R

          +
          • +

        Parameters

        • @@ -288,17 +302,20 @@
          replyHandler: function
            • @@ -310,12 +327,12 @@

            Returns void
            -

            Link {@link #reply(Object)} but allows you to specify delivery options for the reply.

            +

            Link {@link #reply(Object)} but allows you to specify delivery options for the reply.

            Parameters

            @@ -338,15 +355,21 @@

            Returns void
            -

            The same as {@code reply(R message, DeliveryOptions)} but you can specify handler for the reply - i.e. +

            The same as {@code reply(R message, DeliveryOptions)} but you can specify handler for the reply - i.e. to receive the reply to the reply.

            +

            Type parameters

            +
              +
            • +

              R

              +
              • +

            Parameters

            • @@ -369,17 +392,20 @@
              replyHandler: function
                -
              • +
              • Message
                • @@ -448,7 +474,7 @@

                  Returns string isSend

                  • -
                • +
                • reply
                • diff --git a/docs/@vertx/core/classes/messageconsumer.html b/docs/@vertx/core/classes/messageconsumer.html index 3f62a35fc..ef6bf8a79 100644 --- a/docs/@vertx/core/classes/messageconsumer.html +++ b/docs/@vertx/core/classes/messageconsumer.html @@ -57,13 +57,21 @@ MessageConsumer
                -

                Class MessageConsumer

                +

                Class MessageConsumer<T>

        +
        +

        Type parameters

        +
          +
        • +

          T

          +
          • +
        +

        Hierarchy

          @@ -72,6 +80,12 @@

          Hierarchy

        +
        +

        Implements

        + +

        Index

        @@ -84,6 +98,7 @@

        Methods

      • completionHandler
      • endHandler
      • exceptionHandler
        • +
      • fetch
      • getMaxBufferedMessages
      • handler
      • isRegistered
        • @@ -108,7 +123,7 @@

        address

      • @@ -122,18 +137,18 @@

        Returns string

        bodyStream

        • -

          Returns ReadStream

          +

          Returns ReadStream<T>

          a read stream for the body of the message stream.

        @@ -148,12 +163,12 @@

        completionHandler

      • -

        Optional method which can be called to indicate when the registration has been propagated across the cluster.

        +

        Optional method which can be called to indicate when the registration has been propagated across the cluster.

        Parameters

        @@ -166,17 +181,20 @@
        completionHandler: function

        • @@ -237,13 +257,13 @@

        Returns

        exceptionHandler

        • Parameters

          @@ -253,17 +273,19 @@
          handler: function
            • -
            • (result: Error): void | null | undefined
              • +
            • (res: Error): void | Handler<Error> | null | undefined

            • Parameters

              • -
                result: Error
                +
                res: Error

              Returns void + | + Handler<Error> | null | @@ -275,7 +297,31 @@

              Returns void

            -

            Returns MessageConsumer

            +

            Returns MessageConsumer<T>

            +
            • +
          +
        +
        + +

        fetch

        + +
        @@ -289,7 +335,7 @@

        getMaxBufferedMessages

      • @@ -303,13 +349,13 @@

        Returns number

        handler

    @@ -355,7 +403,7 @@

    isRegistered

  • @@ -369,16 +417,17 @@

    Returns boolean

    pause

    • @@ -386,16 +435,17 @@

    Returns

    resume

    @@ -403,20 +453,22 @@

    Returns

    setMaxBufferedMessages

    • -

      Set the number of messages this registration will buffer when this stream is paused. The default - value is 1000. When a new value is set, buffered messages may be discarded to reach - the new value.

      +

      Set the number of messages this registration will buffer when this stream is paused. The default + value is 1000. +

      + When a new value is set, buffered messages may be discarded to reach the new value. The most recent + messages will be kept.

      Parameters

      @@ -428,7 +480,7 @@
      maxBufferedMessages: number
    -

    Returns MessageConsumer

    +

    Returns MessageConsumer<T>

    this registration

    @@ -444,12 +496,12 @@

    unregister

  • -

    Unregisters the handler which created this registration

    +

    Unregisters the handler which created this registration

    Returns void

    @@ -457,12 +509,12 @@

    Returns void
    -

    Unregisters the handler which created this registration

    +

    Unregisters the handler which created this registration

    Parameters

    @@ -476,17 +528,20 @@
    completionHandler: function
      -
    • +
    • MessageConsumer
      • @@ -529,6 +584,9 @@

        Returns void exceptionHandler

        • +
      • + fetch +
      • getMaxBufferedMessages
        • diff --git a/docs/@vertx/core/classes/messageproducer.html b/docs/@vertx/core/classes/messageproducer.html index f118e1d56..e10dce517 100644 --- a/docs/@vertx/core/classes/messageproducer.html +++ b/docs/@vertx/core/classes/messageproducer.html @@ -57,13 +57,21 @@ MessageProducer
      -

      Class MessageProducer

      +

      Class MessageProducer<T>

      +
      +

      Type parameters

      +
        +
      • +

        T

        +
        • +
      +

      Hierarchy

        @@ -72,6 +80,12 @@

        Hierarchy

      +
      +

      Implements

      + +

      Index

      @@ -85,7 +99,7 @@

      Methods

    • drainHandler
    • end
    • exceptionHandler
      • -
    • send
      • +
    • send
    • setWriteQueueMaxSize
    • write
    • writeQueueFull
      • @@ -106,7 +120,7 @@

      address

    • @@ -126,12 +140,12 @@

      close

    • -

      Closes the producer, this method should be called when the message producer is not used anymore.

      +

      Closes the producer, this method should be called when the message producer is not used anymore.

      Returns void

      @@ -142,18 +156,18 @@

      Returns void

      deliveryOptions

      • -

        Update the delivery options of this producer.

        +

        Update the delivery options of this producer.

        Parameters

        @@ -165,7 +179,7 @@
        options: DeliveryO

    -

    Returns MessageProducer

    +

    Returns MessageProducer<T>

    this producer object

    • @@ -174,13 +188,13 @@

    Returns

    drainHandler

    • Parameters

      @@ -190,17 +204,19 @@
      handler: function
        • -
        • (result: void): void | null | undefined
          • +
        • (res: void): void | Handler<void> | null | undefined

        • Parameters

          • -
            result: void
            +
            res: void

          Returns void + | + Handler<void> | null | @@ -212,7 +228,7 @@

          Returns void

        -

        Returns MessageProducer

        +

        Returns MessageProducer<T>

    @@ -220,38 +236,40 @@

    Returns

    end

      -
    • end(t: any): void
      • +
    • end(t: T): void
    • end(): void
    • -

      Same as {@link #end()} but writes some data to the stream before ending.

      +

      Same as {@link #end()} but writes some data to the stream before ending.

      Parameters

      • -
        t: any
        +
        t: T

      Returns void

    • -

      Closes the producer, calls {@link #close()}

      +

      Closes the producer, calls {@link #close()}

      Returns void

      @@ -262,13 +280,13 @@

      Returns void

      exceptionHandler

      • Parameters

        @@ -278,17 +296,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -300,58 +320,64 @@

            Returns void

          -

          Returns MessageProducer

          +

          Returns MessageProducer<T>

    -
    +

    send

    -
      -
    • send(message: any): MessageProducer
      • -
    • send(message: any, replyHandler: function): MessageProducer
      • +
      • -

        This method actually sends a message using the send semantic regardless this producer +

        This method actually sends a message using the send semantic regardless this producer is a sender or a publisher.

        Parameters

        • -
          message: any
          +
          message: T

          the message to send

        -

        Returns MessageProducer

        +

        Returns MessageProducer<T>

        reference to this for fluency

      • -

        Like {@link #send(Object)} but specifying a {@code replyHandler} that will be called if the recipient +

        Like {@link #send(Object)} but specifying a {@code replyHandler} that will be called if the recipient subsequently replies to the message.

        +

        Type parameters

        +
          +
        • +

          R

          +
          • +

        Parameters

        -

        Returns MessageProducer

        +

        Returns MessageProducer<T>

        reference to this for fluency

      @@ -390,13 +419,14 @@

      Returns

      setWriteQueueMaxSize

      • Parameters

        @@ -405,7 +435,7 @@

        Parameters

        maxSize: number
      -

      Returns MessageProducer

      +

      Returns MessageProducer<T>

    @@ -413,22 +443,23 @@

    Returns

    write

    @@ -441,13 +472,14 @@

    writeQueueFull

    • -

      This will return {@code true} if there are more bytes in the write queue than the value set using {@link

      +

      This will return {@code true} if there are more bytes in the write queue than the value set using {@link

      #setWriteQueueMaxSize}

      @@ -470,7 +502,7 @@

      Returns boolean

      -
    • +
    • MessageProducer
      • @@ -491,7 +523,7 @@

        Returns boolean exceptionHandler

        • -
      • +
      • send
      • diff --git a/docs/@vertx/core/classes/metricsoptions.html b/docs/@vertx/core/classes/metricsoptions.html index c8f1ebeff..2f0b159b4 100644 --- a/docs/@vertx/core/classes/metricsoptions.html +++ b/docs/@vertx/core/classes/metricsoptions.html @@ -77,38 +77,109 @@

        Index

        -

        Properties

        +

        Constructors

        +
        +
        +

        Methods

        +
    -

    Properties

    -
    - -

    enabled

    -
    enabled: boolean
    - -
    -
    -

    Set whether metrics will be enabled on the Vert.x instance.

    -
    -
    -
    param
    -

    true if metrics enabled, or false if not.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    isEnabled

    +
      +
    • isEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether metrics will be enabled on the Vert.x instance.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEnabled

    + +
      +
    • + +
      +
      +

      Set whether metrics will be enabled on the Vert.x instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabled: boolean
        +
        • +
      +

      Returns MetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -127,8 +198,14 @@

    enabled

  • MetricsOptions
    • diff --git a/docs/@vertx/core/classes/multimap.html b/docs/@vertx/core/classes/multimap.html index 878b84b59..8a09e30b6 100644 --- a/docs/@vertx/core/classes/multimap.html +++ b/docs/@vertx/core/classes/multimap.html @@ -109,12 +109,12 @@

    add

  • -

    Adds a new value with the specified name and value.

    +

    Adds a new value with the specified name and value.

    Parameters

    @@ -147,12 +147,12 @@

    addAll

  • -

    Adds all the entries from another MultiMap to this one

    +

    Adds all the entries from another MultiMap to this one

    Parameters

    @@ -176,12 +176,12 @@

    clear

  • -

    Removes all

    +

    Removes all

    Returns MultiMap

    @@ -200,12 +200,12 @@

    contains

  • -

    Checks to see if there is a value with the specified name

    +

    Checks to see if there is a value with the specified name

    Parameters

    @@ -223,12 +223,12 @@

    Returns boolean
    -

    Check if there is a header with the specified {@code name} and {@code value}.

    +

    Check if there is a header with the specified {@code name} and {@code value}.

    If {@code caseInsensitive} is {@code true}, {@code value} is compared in a case-insensitive way.

    @@ -265,12 +265,12 @@

    get

  • -

    Returns the value of with the specified name. If there are +

    Returns the value of with the specified name. If there are more than one values for the specified name, the first value is returned.

    @@ -301,12 +301,12 @@

    getAll

  • -

    Returns the values with the specified name

    +

    Returns the values with the specified name

    Parameters

    @@ -334,12 +334,12 @@

    isEmpty

  • -

    Return true if empty

    +

    Return true if empty

    Returns boolean

    @@ -356,12 +356,12 @@

    names

  • -

    Gets a immutable {@link java.util.Set} of all names

    +

    Gets a immutable {@link java.util.Set} of all names

    Returns string[]

    @@ -379,12 +379,12 @@

    remove

  • -

    Removes the value with the given name

    +

    Removes the value with the given name

    Parameters

    @@ -411,12 +411,12 @@

    set

  • -

    Sets a value under the specified name. +

    Sets a value under the specified name.

    If there is an existing header with the same name, it is removed.

    @@ -451,12 +451,12 @@

    setAll

  • -

    Cleans this instance.

    +

    Cleans this instance.

    Parameters

    @@ -480,12 +480,12 @@

    size

  • -

    Return the number of keys.

    +

    Return the number of keys.

    Returns number

    @@ -502,12 +502,12 @@

    Static caseInsensitive
  • -

    Create a multi-map implementation with case insensitive keys, for instance it can be used to hold some HTTP headers.

    +

    Create a multi-map implementation with case insensitive keys, for instance it can be used to hold some HTTP headers.

    Returns MultiMap

    diff --git a/docs/@vertx/core/classes/mxrecord.html b/docs/@vertx/core/classes/mxrecord.html index c7204309f..41f4805b7 100644 --- a/docs/@vertx/core/classes/mxrecord.html +++ b/docs/@vertx/core/classes/mxrecord.html @@ -98,12 +98,12 @@

    name

  • -

    The name of the MX record

    +

    The name of the MX record

    Returns string

    @@ -120,12 +120,12 @@

    priority

  • -

    The priority of the MX record.

    +

    The priority of the MX record.

    Returns number

    diff --git a/docs/@vertx/core/classes/netclient.html b/docs/@vertx/core/classes/netclient.html index fdc769e66..9b74c34ff 100644 --- a/docs/@vertx/core/classes/netclient.html +++ b/docs/@vertx/core/classes/netclient.html @@ -72,6 +72,12 @@

    Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -99,12 +105,12 @@

    close

  • -

    Close the client. +

    Close the client.

    Any sockets which have not been closed manually will be closed here. The close is asynchronous and may not complete until some time after the method has returned.

    @@ -127,12 +133,12 @@

    connect

  • -

    Open a connection to a server at the specific {@code port} and {@code host}. +

    Open a connection to a server at the specific {@code port} and {@code host}.

    {@code host} can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the {@code connectHandler} instance

    @@ -157,17 +163,20 @@
    connectHandler: function
    • diff --git a/docs/@vertx/core/classes/netclientoptions.html b/docs/@vertx/core/classes/netclientoptions.html index 6c5f3d098..36e1e3a26 100644 --- a/docs/@vertx/core/classes/netclientoptions.html +++ b/docs/@vertx/core/classes/netclientoptions.html @@ -77,852 +77,2170 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - -
    -
    -

    Set the connect timeout

    -
    -
    -
    param
    -

    connect timeout, in ms

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - -
    -
    -

    Add a CRL path

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - -
    -
    -

    Add a CRL value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - -
    -
    -

    Add an enabled cipher suite, appended to the ordered suites.

    -
    -
    -
    param
    -

    the suite

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - -
    -
    -

    Sets the list of enabled SSL/TLS protocols.

    -
    -
    -
    param
    -

    the SSL/TLS protocols to enable

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): NetClientOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        +

        the SSL/TLS protocols to enable

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    hostnameVerificationAlgorithm

    -
    hostnameVerificationAlgorithm: string
    - -
    -
    -

    Set the hostname verification algorithm interval - To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    -
    -
    -
    param
    -

    should be HTTPS, LDAPS or an empty String

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the connect timeout

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - -
    -
    -

    Set the idle timeout, in seconds. zero means don't timeout. - This determines if a connection will timeout and be closed if no data is received within the timeout.

    -
    -
    -
    param
    -

    the timeout, in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getCrlValues

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - -
    -
    -

    Set the key/cert options in jks format, aka Java keystore.

    -
    -
    -
    param
    -

    the key store in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - -
    -
    -

    Set the local interface to bind for network connections. When the local address is null, - it will pick any local address, the default local address is null.

    -
    -
    -
    param
    -

    the local address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - -
    -
    -

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    -
    -
    -
    param
    -

    true for logging the network activity

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHostnameVerificationAlgorithm

    +
      +
    • getHostnameVerificationAlgorithm(): string
      • +
    +
      +
    • + +
      +
      +

      Set the hostname verification algorithm interval + To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - -
    -
    -

    Set the metrics name identifying the reported metrics, useful for grouping metrics - with the same name.

    -
    -
    -
    param
    -

    the metrics name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +

      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getJdkSslEngineOptions

    + + +
    +
    + +

    getKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Set the local interface to bind for network connections. When the local address is null, + it will pick any local address, the default local address is null.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the metrics name identifying the reported metrics, useful for grouping metrics + with the same name.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    + + +
    +
    + +

    getPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pem format

      +
      +
      +

      Returns PemTrustOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getProxyOptions

    + +
      +
    • + +
      +
      +

      Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

      +
      +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReconnectAttempts

    +
      +
    • getReconnectAttempts(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of reconnect attempts

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReconnectInterval

    +
      +
    • getReconnectInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Set the reconnect interval

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether all server certificates should be trusted

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +
      deprecated
      +

      this has no effect, just don't use it

      +
      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +
      +
      +

      Set the connect timeout

      +
      +
      +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        +

        connect timeout, in ms

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): NetClientOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        +

        the SSL/TLS protocols to enable

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHostnameVerificationAlgorithm

    +
      +
    • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): NetClientOptions
      • +
    +
      +
    • + +
      +
      +

      Set the hostname verification algorithm interval + To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

      +
      +
      +

      Parameters

      +
        +
      • +
        hostnameVerificationAlgorithm: string
        +
        +

        should be HTTPS, LDAPS or an empty String

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +
      +
      +

      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +

      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

      +
      +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        +

        the timeout, in seconds

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        +

        specify time unit.

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    + + +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLocalAddress

    + +
      +
    • + +
      +
      +

      Set the local interface to bind for network connections. When the local address is null, + it will pick any local address, the default local address is null.

      +
      +
      +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        +

        the local address

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        +

        true for logging the network activity

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMetricsName

    + +
      +
    • + +
      +
      +

      Set the metrics name identifying the reported metrics, useful for grouping metrics + with the same name.

      +
      +
      +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        +

        the metrics name

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    setOpenSslEngineOptions

    + +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - -
    -
    -

    Set the key/cert store options in pem format.

    -
    -
    -
    param
    -

    the options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - -
    -
    -

    Set the trust options in pem format

    -
    -
    -
    param
    -

    the trust options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pem format

      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - -
    -
    -

    Set the key/cert options in pfx format.

    -
    -
    -
    param
    -

    the key cert options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - -
    -
    -

    Set the trust options in pfx format

    -
    -
    -
    param
    -

    the trust options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - -
    -
    -

    Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    -
    -
    -
    param
    -

    proxy options object

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setProxyOptions

    + +
      +
    • + +
      +
      +

      Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

      +
      +
      +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        +

        proxy options object

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - -
    -
    -

    Set the TCP receive buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reconnectAttempts

    -
    reconnectAttempts: number
    - -
    -
    -

    Set the value of reconnect attempts

    -
    -
    -
    param
    -

    the maximum number of reconnect attempts

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReconnectAttempts

    + +
      +
    • + +
      +
      +

      Set the value of reconnect attempts

      +
      +
      +

      Parameters

      +
        +
      • +
        reconnectAttempts: number
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reconnectInterval

    -
    reconnectInterval: number
    - -
    -
    -

    Set the reconnect interval

    -
    -
    -
    param
    -

    the reconnect interval in ms

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReconnectInterval

    + +
      +
    • + +
      +
      +

      Set the reconnect interval

      +
      +
      +

      Parameters

      +
        +
      • +
        reconnectInterval: number
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - -
    -
    -

    Set the value of reuse address

    -
    -
    -
    param
    -

    the value of reuse address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReuseAddress

    + +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        +

        the value of reuse address

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - -
    -
    -

    Set the value of reuse port. -

    - This is only supported by native transports.

    -
    -
    -
    param
    -

    the value of reuse port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReusePort

    + +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        +

        the value of reuse port

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - -
    -
    -

    Set the TCP send buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSendBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - -
    -
    -

    Set whether SO_linger keep alive is enabled

    -
    -
    -
    param
    -

    true if SO_linger is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSoLinger

    + +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        +

        true if SO_linger is enabled

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set whether SSL/TLS is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - -
    -
    -

    Enable the {@code TCP_CORK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the cork value

    -
    -
    -
    +
    + +

    setTcpCork

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        +

        the cork value

        +
        +
        • +
      +

      Returns NetClientOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - -
    -
    -

    Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

    -
    -
    -
    param
    -

    the fast open value

    -
    -
    -
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        +

        the fast open value

        +
        +
        • +
      +

      Returns NetClientOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - -
    -
    -

    Set whether TCP keep alive is enabled

    -
    -
    -
    param
    -

    true if TCP keep alive is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        +

        true if TCP keep alive is enabled

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - -
    -
    -

    Set whether TCP no delay is enabled

    -
    -
    -
    param
    -

    true if TCP no delay is enabled (Nagle disabled)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        +

        true if TCP no delay is enabled (Nagle disabled)

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - -
    -
    -

    Enable the {@code TCP_QUICKACK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the quick ack value

    -
    -
    -
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        +

        the quick ack value

        +
        +
        • +
      +

      Returns NetClientOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - -
    -
    -

    Set the value of traffic class

    -
    -
    -
    param
    -

    the value of traffic class

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrafficClass

    + +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        +

        the value of traffic class

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - -
    -
    -

    Set whether all server certificates should be trusted

    -
    -
    -
    param
    -

    true if all should be trusted

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrustAll

    + +
      +
    • + +
      +
      +

      Set whether all server certificates should be trusted

      +
      +
      +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        +

        true if all should be trusted

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - -
    -
    -

    Set the trust options in jks format, aka Java truststore

    -
    -
    -
    param
    -

    the trust options in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Parameters

      + +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - -
    -
    -

    Set the ALPN usage.

    -
    -
    -
    param
    -

    true when Application-Layer Protocol Negotiation should be used

    -
    -
    -
    +
    + +

    setUseAlpn

    + +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        +

        true when Application-Layer Protocol Negotiation should be used

        +
        +
        • +
      +

      Returns NetClientOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - -
    -
    -

    Set whether Netty pooled buffers are enabled

    -
    -
    -
    param
    -

    true if pooled buffers enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +
      deprecated
      +

      this has no effect, just don't use it

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        +

        true if pooled buffers enabled

        +
        +
        • +
      +

      Returns NetClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -941,113 +2259,233 @@

    usePooledBuffers

  • NetClientOptions
    • diff --git a/docs/@vertx/core/classes/netserver.html b/docs/@vertx/core/classes/netserver.html index 15fa24fa1..347e8b824 100644 --- a/docs/@vertx/core/classes/netserver.html +++ b/docs/@vertx/core/classes/netserver.html @@ -72,6 +72,12 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -83,7 +89,6 @@

    Methods

  • close
  • connectHandler
  • connectStream
    • -
  • exceptionHandler
  • isMetricsEnabled
  • listen
    • @@ -103,12 +108,12 @@

    actualPort

  • -

    The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number +

    The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port

    @@ -128,12 +133,12 @@

    close

  • -

    Close the server. This will close any currently open connections. The close may not complete until after this +

    Close the server. This will close any currently open connections. The close may not complete until after this method has returned.

    @@ -142,12 +147,12 @@

    Returns void
    -

    Like {@link #close} but supplying a handler that will be notified when close is complete.

    +

    Like {@link #close} but supplying a handler that will be notified when close is complete.

    Parameters

    @@ -160,17 +165,20 @@
    completionHandler: function
      • @@ -191,12 +199,12 @@

      connectHandler

    • -

      Supply a connect handler for this server. The server can only have at most one connect handler at any one time. +

      Supply a connect handler for this server. The server can only have at most one connect handler at any one time. As the server accepts TCP or SSL connections it creates an instance of NetSocket and passes it to the connect handler.

      @@ -208,17 +216,19 @@
      handler: function

        • Parameters

          Returns void + | + Handler<NetSocket> | null | @@ -239,78 +249,27 @@

          Returns

          connectStream

          • -

            Return the connect stream for this server. The server can only have at most one handler at any one time. +

            Return the connect stream for this server. The server can only have at most one handler at any one time. As the server accepts TCP or SSL connections it creates an instance of NetSocket and passes it to the connect stream {@link ReadStream#handler(io.vertx.core.Handler)}.

            -

            Returns ReadStream

            +

            Returns ReadStream<NetSocket>

            the connect stream

    • -
    - -

    exceptionHandler

    -
      -
    • exceptionHandler(handler: function): NetServer
      • -
    -
      -
    • - -
      -
      -

      Set an exception handler called for socket errors happening before the connection - is passed to the {@link #connectHandler}, e.g during the TLS handshake.

      -
      -
      -

      Parameters

      -
        -
      • -
        handler: function
        -
        -

        the handler to set

        -
        -
          -
        • -
            -
          • (result: Error): void
            • -
          -
            -
          • -

            Parameters

            -
              -
            • -
              result: Error
              -
              • -
            -

            Returns void

            -
            • -
          -
          • -
        -
        • -
      -

      Returns NetServer

      -

      a reference to this, so the API can be used fluently

      -
      • -
    -

    isMetricsEnabled

    @@ -320,17 +279,23 @@

    isMetricsEnabled

    • -

      Whether the metrics are enabled for this measured object

      +

      Whether the metrics are enabled for this measured object

      +
      +
      implspec
      +

      The default implementation returns {@code false}

      +
      +

      Returns boolean

      -

      true if the metrics are enabled

      +

      if metrics are enabled

    @@ -351,12 +316,12 @@

    listen

  • -

    Start listening on the port and host as configured in the {@link io.vertx.core.net.NetServerOptions} used when +

    Start listening on the port and host as configured in the {@link io.vertx.core.net.NetServerOptions} used when creating the server.

    The server may not be listening until some time after the call to listen has returned.

    @@ -368,12 +333,12 @@

    Returns
    -

    Like {@link #listen} but providing a handler that will be notified when the server is listening, or fails.

    +

    Like {@link #listen} but providing a handler that will be notified when the server is listening, or fails.

    Parameters

    @@ -386,17 +351,20 @@
    listenHandler: function

    • -

    Properties

    -
    - -

    acceptBacklog

    -
    acceptBacklog: number
    - -
    -
    -

    Set the accept back log

    -
    -
    -
    param
    -

    accept backlog

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    clientAuth

    -
    clientAuth: ClientAuth
    - -
    -
    -

    Set whether client auth is required

    -
    -
    -
    param
    -

    One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the - SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then - it won't mandate the certificate to be presented, basically make it optional.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clientAuthRequired

    -
    clientAuthRequired: boolean
    - -
    -
    -

    Set whether client auth is required

    -
    -
    -
    param
    -

    true if client auth is required

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - -
    -
    -

    Add a CRL path

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - -
    -
    -

    Add a CRL value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): NetServerOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        +

        the SSL/TLS protocols to enable

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - -
    -
    -

    Add an enabled cipher suite, appended to the ordered suites.

    -
    -
    -
    param
    -

    the suite

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getAcceptBacklog

    +
      +
    • getAcceptBacklog(): number
      • +
    +
      +
    • + +
      +
      +

      Set the accept back log

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - -
    -
    -

    Sets the list of enabled SSL/TLS protocols.

    -
    -
    -
    param
    -

    the SSL/TLS protocols to enable

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClientAuth

    + +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Returns ClientAuth

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the host

    -
    -
    -
    param
    -

    the host

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Add a CRL path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - -
    -
    -

    Set the idle timeout, in seconds. zero means don't timeout. - This determines if a connection will timeout and be closed if no data is received within the timeout.

    -
    -
    -
    param
    -

    the timeout, in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCrlValues

    + +
      +
    • + +
      +
      +

      Add a CRL value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +
      +
      +

      Add an enabled cipher suite, appended to the ordered suites.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the host

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +

      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getJdkSslEngineOptions

    + + +
    +
    + +

    getKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    + + +
    +
    + +

    getPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pem format

      +
      +
      +

      Returns PemTrustOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isClientAuthRequired

    +
      +
    • isClientAuthRequired(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSni

    +
      +
    • isSni(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the server supports Server Name Indiciation

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +
      deprecated
      +

      this has no effect, just don't use it

      +
      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAcceptBacklog

    + +
      +
    • + +
      +
      +

      Set the accept back log

      +
      +
      +

      Parameters

      +
        +
      • +
        acceptBacklog: number
        +
        +

        accept backlog

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClientAuth

    + +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Parameters

      +
        +
      • +
        clientAuth: ClientAuth
        +
        +

        One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the + SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then + it won't mandate the certificate to be presented, basically make it optional.

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClientAuthRequired

    + +
      +
    • + +
      +
      +

      Set whether client auth is required

      +
      +
      +

      Parameters

      +
        +
      • +
        clientAuthRequired: boolean
        +
        +

        true if client auth is required

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): NetServerOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the list of enabled SSL/TLS protocols.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        +

        the SSL/TLS protocols to enable

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set the host

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the host

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +
      +
      +

      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

      +
      +

      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

      +
      +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        +

        the timeout, in seconds

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +
      +
      +

      Set the idle timeout unit. If not specified, default is seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        +

        specify time unit.

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - -
    -
    -

    Set the key/cert options in jks format, aka Java keystore.

    -
    -
    -
    param
    -

    the key store in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setJdkSslEngineOptions

    + +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - -
    -
    -

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    -
    -
    -
    param
    -

    true for logging the network activity

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in jks format, aka Java keystore.

      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    setLogActivity

    + +
      +
    • + +
      +
      +

      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

      +
      +
      +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        +

        true for logging the network activity

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - -
    -
    -

    Set the key/cert store options in pem format.

    -
    -
    -
    param
    -

    the options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setOpenSslEngineOptions

    + +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - -
    -
    -

    Set the trust options in pem format

    -
    -
    -
    param
    -

    the trust options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert store options in pem format.

      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - -
    -
    -

    Set the key/cert options in pfx format.

    -
    -
    -
    param
    -

    the key cert options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pem format

      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - -
    -
    -

    Set the trust options in pfx format

    -
    -
    -
    param
    -

    the trust options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +
      +
      +

      Set the key/cert options in pfx format.

      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port

    -
    -
    -
    param
    -

    the port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in pfx format

      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - -
    -
    -

    Set the TCP receive buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the port

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - -
    -
    -

    Set the value of reuse address

    -
    -
    -
    param
    -

    the value of reuse address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP receive buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - -
    -
    -

    Set the value of reuse port. -

    - This is only supported by native transports.

    -
    -
    -
    param
    -

    the value of reuse port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReuseAddress

    + +
      +
    • + +
      +
      +

      Set the value of reuse address

      +
      +
      +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        +

        the value of reuse address

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - -
    -
    -

    Set the TCP send buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setReusePort

    + +
      +
    • + +
      +
      +

      Set the value of reuse port. +

      + This is only supported by native transports.

      +
      +
      +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        +

        the value of reuse port

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sni

    -
    sni: boolean
    - -
    -
    -

    Set whether the server supports Server Name Indiciation

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSendBufferSize

    + +
      +
    • + +
      +
      +

      Set the TCP send buffer size

      +
      +
      +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        +

        the buffers size, in bytes

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - -
    -
    -

    Set whether SO_linger keep alive is enabled

    -
    -
    -
    param
    -

    true if SO_linger is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSni

    + +
      +
    • + +
      +
      +

      Set whether the server supports Server Name Indiciation

      +
      +
      +

      Parameters

      +
        +
      • +
        sni: boolean
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set whether SSL/TLS is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSoLinger

    + +
      +
    • + +
      +
      +

      Set whether SO_linger keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        +

        true if SO_linger is enabled

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - -
    -
    -

    Enable the {@code TCP_CORK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the cork value

    -
    -
    -
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - -
    -
    -

    Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

    -
    -
    -
    param
    -

    the fast open value

    -
    -
    -
    +
    + +

    setTcpCork

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_CORK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        +

        the cork value

        +
        +
        • +
      +

      Returns NetServerOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - -
    -
    -

    Set whether TCP keep alive is enabled

    -
    -
    -
    param
    -

    true if TCP keep alive is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        +

        the fast open value

        +
        +
        • +
      +

      Returns NetServerOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - -
    -
    -

    Set whether TCP no delay is enabled

    -
    -
    -
    param
    -

    true if TCP no delay is enabled (Nagle disabled)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +
      +
      +

      Set whether TCP keep alive is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        +

        true if TCP keep alive is enabled

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - -
    -
    -

    Enable the {@code TCP_QUICKACK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the quick ack value

    -
    -
    -
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +
      +
      +

      Set whether TCP no delay is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        +

        true if TCP no delay is enabled (Nagle disabled)

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - -
    -
    -

    Set the value of traffic class

    -
    -
    -
    param
    -

    the value of traffic class

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +
      +
      +

      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        +

        the quick ack value

        +
        +
        • +
      +

      Returns NetServerOptions

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - -
    -
    -

    Set the trust options in jks format, aka Java truststore

    -
    -
    -
    param
    -

    the trust options in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTrafficClass

    + +
      +
    • + +
      +
      +

      Set the value of traffic class

      +
      +
      +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        +

        the value of traffic class

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - -
    -
    -

    Set the ALPN usage.

    -
    -
    -
    param
    -

    true when Application-Layer Protocol Negotiation should be used

    -
    -
    -
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +
      +
      +

      Set the trust options in jks format, aka Java truststore

      +
      +
      +

      Parameters

      + +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - -
    -
    -

    Set whether Netty pooled buffers are enabled

    -
    -
    -
    param
    -

    true if pooled buffers enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setUseAlpn

    + +
      +
    • + +
      +
      +

      Set the ALPN usage.

      +
      +
      +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        +

        true when Application-Layer Protocol Negotiation should be used

        +
        +
        • +
      +

      Returns NetServerOptions

      +
      • +
    +
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +
      +
      +

      Set whether Netty pooled buffers are enabled

      +
      +
      +
      deprecated
      +

      this has no effect, just don't use it

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        +

        true if pooled buffers enabled

        +
        +
        • +
      +

      Returns NetServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -889,107 +2144,221 @@

    usePooledBuffers

  • NetServerOptions
    • diff --git a/docs/@vertx/core/classes/netsocket.html b/docs/@vertx/core/classes/netsocket.html index 29dd08620..2bfa7366e 100644 --- a/docs/@vertx/core/classes/netsocket.html +++ b/docs/@vertx/core/classes/netsocket.html @@ -72,6 +72,13 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -85,6 +92,7 @@

    Methods

  • end
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • handler
  • indicatedServerName
  • isSsl
    • @@ -115,12 +123,12 @@

    close

  • -

    Close the NetSocket

    +

    Close the NetSocket

    Returns void

    @@ -137,12 +145,12 @@

    closeHandler

  • -

    Set a handler that will be called when the NetSocket is closed

    +

    Set a handler that will be called when the NetSocket is closed

    Parameters

    @@ -155,17 +163,19 @@
    handler: function
      • -
      • (result: void): void | null | undefined
        • +
      • (res: void): void | Handler<void> | null | undefined

      • Parameters

        • -
          result: void
          +
          res: void

        Returns void + | + Handler<void> | null | @@ -192,7 +202,7 @@

        drainHandler

      • Parameters

        @@ -202,17 +212,19 @@
        handler: function
          • -
          • (result: void): void | null | undefined
            • +
          • (res: void): void | Handler<void> | null | undefined

          • Parameters

            • -
              result: void
              +
              res: void

            Returns void + | + Handler<void> | null | @@ -239,12 +251,12 @@

            end

          • -

            Same as {@link #end()} but writes some data to the stream before ending.

            +

            Same as {@link #end()} but writes some data to the stream before ending.

            Parameters

            @@ -257,13 +269,14 @@

            Returns void
          • -

            Calls {@link #close()}

            +

            Calls {@link #close()}

            Returns void

            @@ -280,9 +293,17 @@

            endHandler

          • +
            +
            +

            {@inheritDoc} +

            + This handler might be called after the close handler when the socket is paused and there are still + buffers to deliver.

            +
            +

            Parameters

            • @@ -290,17 +311,19 @@
              endHandler: function
                • -
                • (result: void): void | null | undefined
                  • +
                • (res: void): void | Handler<void> | null | undefined

                • Parameters

                  • -
                    result: void
                    +
                    res: void

                  Returns void + | + Handler<void> | null | @@ -326,7 +349,7 @@

                  exceptionHandler

                • Parameters

                  @@ -336,17 +359,19 @@
                  handler: function
                    • -
                    • (result: Error): void | null | undefined
                      • +
                    • (res: Error): void | Handler<Error> | null | undefined

                    • Parameters

                      • -
                        result: Error
                        +
                        res: Error

                      Returns void + | + Handler<Error> | null | @@ -362,6 +387,30 @@

                      Returns + +

                      fetch

                      + +
                        +
                      • + +

                        Parameters

                        +
                          +
                        • +
                          amount: number
                          +
                          • +
                        +

                        Returns NetSocket

                        +
                        • +
                      +

    • handler

    @@ -372,7 +421,7 @@

    handler

  • Parameters

    @@ -382,17 +431,19 @@
    handler: function
    • @@ -999,12 +1113,12 @@

    writeHandlerID

  • -

    When a {@code NetSocket} is created it automatically registers an event handler with the event bus, the ID of that +

    When a {@code NetSocket} is created it automatically registers an event handler with the event bus, the ID of that handler is given by {@code writeHandlerID}.

    Given this ID, a different event loop can send a buffer to that event handler using the event bus and @@ -1026,13 +1140,14 @@

    writeQueueFull

    • -

      This will return {@code true} if there are more bytes in the write queue than the value set using {@link

      +

      This will return {@code true} if there are more bytes in the write queue than the value set using {@link

      #setWriteQueueMaxSize}

      @@ -1076,6 +1191,9 @@

      Returns boolean exceptionHandler

      • +
    • + fetch +
    • handler
      • diff --git a/docs/@vertx/core/classes/networkoptions.html b/docs/@vertx/core/classes/networkoptions.html new file mode 100644 index 000000000..22634df32 --- /dev/null +++ b/docs/@vertx/core/classes/networkoptions.html @@ -0,0 +1,607 @@ + + + + + + NetworkOptions | @vertx/core + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
        • +
      • Public/Protected
        • +
      • All
        • +
      +
      + + + + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Class NetworkOptions

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • + NetworkOptions +
        • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Constructors

      + +
      +
      +

      Methods

      + +
      +
      +
      +
      +
      +

      Constructors

      +
      + +

      constructor

      + + +
      +
      +
      +

      Methods

      +
      + +

      getLogActivity

      +
        +
      • getLogActivity(): boolean
        • +
      +
        +
      • + +
        +
        +

        Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

        +
        +
        +

        Returns boolean

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      getReceiveBufferSize

      +
        +
      • getReceiveBufferSize(): number
        • +
      +
        +
      • + +
        +
        +

        Set the TCP receive buffer size

        +
        +
        +

        Returns number

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      getSendBufferSize

      +
        +
      • getSendBufferSize(): number
        • +
      +
        +
      • + +
        +
        +

        Set the TCP send buffer size

        +
        +
        +

        Returns number

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      getTrafficClass

      +
        +
      • getTrafficClass(): number
        • +
      +
        +
      • + +
        +
        +

        Set the value of traffic class

        +
        +
        +

        Returns number

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      isReuseAddress

      +
        +
      • isReuseAddress(): boolean
        • +
      +
        +
      • + +
        +
        +

        Set the value of reuse address

        +
        +
        +

        Returns boolean

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      isReusePort

      +
        +
      • isReusePort(): boolean
        • +
      +
        +
      • + +
        +
        +

        Set the value of reuse port. +

        + This is only supported by native transports.

        +
        +
        +

        Returns boolean

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      setLogActivity

      + +
        +
      • + +
        +
        +

        Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

        +
        +
        +

        Parameters

        +
          +
        • +
          logActivity: boolean
          +
          +

          true for logging the network activity

          +
          +
          • +
        +

        Returns NetworkOptions

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      setReceiveBufferSize

      + +
        +
      • + +
        +
        +

        Set the TCP receive buffer size

        +
        +
        +

        Parameters

        +
          +
        • +
          receiveBufferSize: number
          +
          +

          the buffers size, in bytes

          +
          +
          • +
        +

        Returns NetworkOptions

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      setReuseAddress

      + +
        +
      • + +
        +
        +

        Set the value of reuse address

        +
        +
        +

        Parameters

        +
          +
        • +
          reuseAddress: boolean
          +
          +

          the value of reuse address

          +
          +
          • +
        +

        Returns NetworkOptions

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      setReusePort

      + +
        +
      • + +
        +
        +

        Set the value of reuse port. +

        + This is only supported by native transports.

        +
        +
        +

        Parameters

        +
          +
        • +
          reusePort: boolean
          +
          +

          the value of reuse port

          +
          +
          • +
        +

        Returns NetworkOptions

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      setSendBufferSize

      + +
        +
      • + +
        +
        +

        Set the TCP send buffer size

        +
        +
        +

        Parameters

        +
          +
        • +
          sendBufferSize: number
          +
          +

          the buffers size, in bytes

          +
          +
          • +
        +

        Returns NetworkOptions

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      + +

      setTrafficClass

      + +
        +
      • + +
        +
        +

        Set the value of traffic class

        +
        +
        +

        Parameters

        +
          +
        • +
          trafficClass: number
          +
          +

          the value of traffic class

          +
          +
          • +
        +

        Returns NetworkOptions

        +

        a reference to this, so the API can be used fluently

        +
        • +
      +
      +
      +
      +
      + + +
      +
      +
      +
      +
      +

      Legend

      +
      +
        +
      • Module
        • +
      • Object literal
        • +
      • Variable
        • +
      • Function
        • +
      • Function with type parameter
        • +
      • Index signature
        • +
      • Type alias
        • +
      +
        +
      • Enumeration
        • +
      • Enumeration member
        • +
      • Property
        • +
      • Method
        • +
      +
        +
      • Interface
        • +
      • Interface with type parameter
        • +
      • Constructor
        • +
      • Property
        • +
      • Method
        • +
      • Index signature
        • +
      +
        +
      • Class
        • +
      • Class with type parameter
        • +
      • Constructor
        • +
      • Property
        • +
      • Method
        • +
      • Accessor
        • +
      • Index signature
        • +
      +
        +
      • Inherited constructor
        • +
      • Inherited property
        • +
      • Inherited method
        • +
      • Inherited accessor
        • +
      +
        +
      • Protected property
        • +
      • Protected method
        • +
      • Protected accessor
        • +
      +
        +
      • Private property
        • +
      • Private method
        • +
      • Private accessor
        • +
      +
        +
      • Static property
        • +
      • Static method
        • +
      +
      +
      +
      +
      +

      Generated using TypeDoc

      +
      +
      + + + + \ No newline at end of file diff --git a/docs/@vertx/core/classes/openoptions.html b/docs/@vertx/core/classes/openoptions.html index 1bd7534e0..eca125afe 100644 --- a/docs/@vertx/core/classes/openoptions.html +++ b/docs/@vertx/core/classes/openoptions.html @@ -77,278 +77,682 @@

      Index

      -

      Properties

      +

      Constructors

      +
      +
      +

      Methods

      +
    • -

    Properties

    -
    - -

    append

    -
    append: boolean
    - -
    -
    -

    Whether the file should be opened in append mode. Defaults to {@code false}.

    -
    -
    -
    param
    -

    true to open file in append mode, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns OpenOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns OpenOptions

      +
      • +
    -
    - -

    create

    -
    create: boolean
    - -
    -
    -

    Set whether the file should be created if it does not already exist.

    -
    -
    -
    param
    -

    true if the file should be created if it does not already exist

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getPerms

    +
      +
    • getPerms(): string
      • +
    +
      +
    • + +
      +
      +

      Set the permissions string

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    createNew

    -
    createNew: boolean
    - -
    -
    -

    Set whether the file should be created and fail if it does exist already.

    -
    -
    -
    param
    -

    true if the file should be created or fail if it exists already

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isAppend

    +
      +
    • isAppend(): boolean
      • +
    +
      +
    • + +
      +
      +

      Whether the file should be opened in append mode. Defaults to {@code false}.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    deleteOnClose

    -
    deleteOnClose: boolean
    - -
    -
    -

    Set whether the file should be deleted when it's closed, or the JVM is shutdown.

    -
    -
    -
    param
    -

    whether the file should be deleted when it's closed, or the JVM is shutdown.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isCreate

    +
      +
    • isCreate(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the file should be created if it does not already exist.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    dsync

    -
    dsync: boolean
    - -
    -
    -

    Set whether every write to the file's content ill be written synchronously to the underlying hardware.

    -
    -
    -
    param
    -

    true if sync

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isCreateNew

    +
      +
    • isCreateNew(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the file should be created and fail if it does exist already.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    perms

    -
    perms: string
    - -
    -
    -

    Set the permissions string

    -
    -
    -
    param
    -

    the permissions string

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isDeleteOnClose

    +
      +
    • isDeleteOnClose(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the file should be deleted when it's closed, or the JVM is shutdown.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    read

    -
    read: boolean
    - -
    -
    -

    Set whether the file is to be opened for reading

    -
    -
    -
    param
    -

    true if the file is to be opened for reading

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isDsync

    +
      +
    • isDsync(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether every write to the file's content ill be written synchronously to the underlying hardware.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sparse

    -
    sparse: boolean
    - -
    -
    -

    Set whether a hint should be provided that the file to created is sparse

    -
    -
    -
    param
    -

    true if a hint should be provided that the file to created is sparse

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isRead

    +
      +
    • isRead(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the file is to be opened for reading

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sync

    -
    sync: boolean
    - -
    -
    -

    Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.

    -
    -
    -
    param
    -

    true if sync

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isSparse

    +
      +
    • isSparse(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether a hint should be provided that the file to created is sparse

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    truncateExisting

    -
    truncateExisting: boolean
    - -
    -
    -

    Set whether the file should be truncated to zero length on opening if it exists and is opened for write

    -
    -
    -
    param
    -

    true if the file should be truncated to zero length on opening if it exists and is opened for write

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isSync

    +
      +
    • isSync(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    write

    -
    write: boolean
    - -
    -
    -

    Set whether the file is to be opened for writing

    -
    -
    -
    param
    -

    true if the file is to be opened for writing

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isTruncateExisting

    +
      +
    • isTruncateExisting(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the file should be truncated to zero length on opening if it exists and is opened for write

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isWrite

    +
      +
    • isWrite(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the file is to be opened for writing

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAppend

    + +
      +
    • + +
      +
      +

      Whether the file should be opened in append mode. Defaults to {@code false}.

      +
      +
      +

      Parameters

      +
        +
      • +
        append: boolean
        +
        +

        true to open file in append mode, false otherwise

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCreate

    + +
      +
    • + +
      +
      +

      Set whether the file should be created if it does not already exist.

      +
      +
      +

      Parameters

      +
        +
      • +
        create: boolean
        +
        +

        true if the file should be created if it does not already exist

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCreateNew

    + +
      +
    • + +
      +
      +

      Set whether the file should be created and fail if it does exist already.

      +
      +
      +

      Parameters

      +
        +
      • +
        createNew: boolean
        +
        +

        true if the file should be created or fail if it exists already

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDeleteOnClose

    +
      +
    • setDeleteOnClose(deleteOnClose: boolean): OpenOptions
      • +
    +
      +
    • + +
      +
      +

      Set whether the file should be deleted when it's closed, or the JVM is shutdown.

      +
      +
      +

      Parameters

      +
        +
      • +
        deleteOnClose: boolean
        +
        +

        whether the file should be deleted when it's closed, or the JVM is shutdown.

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDsync

    + +
      +
    • + +
      +
      +

      Set whether every write to the file's content ill be written synchronously to the underlying hardware.

      +
      +
      +

      Parameters

      +
        +
      • +
        dsync: boolean
        +
        +

        true if sync

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPerms

    + +
      +
    • + +
      +
      +

      Set the permissions string

      +
      +
      +

      Parameters

      +
        +
      • +
        perms: string
        +
        +

        the permissions string

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRead

    + +
      +
    • + +
      +
      +

      Set whether the file is to be opened for reading

      +
      +
      +

      Parameters

      +
        +
      • +
        read: boolean
        +
        +

        true if the file is to be opened for reading

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSparse

    + +
      +
    • + +
      +
      +

      Set whether a hint should be provided that the file to created is sparse

      +
      +
      +

      Parameters

      +
        +
      • +
        sparse: boolean
        +
        +

        true if a hint should be provided that the file to created is sparse

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSync

    + +
      +
    • + +
      +
      +

      Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.

      +
      +
      +

      Parameters

      +
        +
      • +
        sync: boolean
        +
        +

        true if sync

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setTruncateExisting

    +
      +
    • setTruncateExisting(truncateExisting: boolean): OpenOptions
      • +
    +
      +
    • + +
      +
      +

      Set whether the file should be truncated to zero length on opening if it exists and is opened for write

      +
      +
      +

      Parameters

      +
        +
      • +
        truncateExisting: boolean
        +
        +

        true if the file should be truncated to zero length on opening if it exists and is opened for write

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWrite

    + +
      +
    • + +
      +
      +

      Set whether the file is to be opened for writing

      +
      +
      +

      Parameters

      +
        +
      • +
        write: boolean
        +
        +

        true if the file is to be opened for writing

        +
        +
        • +
      +

      Returns OpenOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -367,38 +771,74 @@

    write

  • OpenOptions
    • diff --git a/docs/@vertx/core/classes/opensslengineoptions.html b/docs/@vertx/core/classes/opensslengineoptions.html index 12b590737..3a4475826 100644 --- a/docs/@vertx/core/classes/opensslengineoptions.html +++ b/docs/@vertx/core/classes/opensslengineoptions.html @@ -77,38 +77,112 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    sessionCacheEnabled

    -
    sessionCacheEnabled: boolean
    - -
    -
    -

    Set whether session cache is enabled in open SSL session server context

    -
    -
    -
    param
    -

    true if session cache is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    isSessionCacheEnabled

    +
      +
    • isSessionCacheEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether session cache is enabled in open SSL session server context

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSessionCacheEnabled

    + +
      +
    • + +
      +
      +

      Set whether session cache is enabled in open SSL session server context

      +
      +
      +

      Parameters

      +
        +
      • +
        sessionCacheEnabled: boolean
        +
        +

        true if session cache is enabled

        +
        +
        • +
      +

      Returns OpenSSLEngineOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -127,8 +201,14 @@

    sessionCacheEnabled

  • OpenSSLEngineOptions
    • diff --git a/docs/@vertx/core/classes/option.html b/docs/@vertx/core/classes/option.html index a0b358a26..b6d553920 100644 --- a/docs/@vertx/core/classes/option.html +++ b/docs/@vertx/core/classes/option.html @@ -77,307 +77,810 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    argName

    -
    argName: string
    - -
    -
    -

    Sets te arg name for this option.

    -
    -
    -
    param
    -

    the arg name, must not be {@code null}

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Option

      +
      • +
    • + +

      Parameters

      + +

      Returns Option

      +
      • +
    -
    - -

    choices

    -
    choices: string
    - -
    -
    -

    Sets the list of values accepted by this option. If the value set by the user does not match once of these - values, a {@link InvalidValueException} exception is thrown.

    -
    -
    -
    param
    -

    the choices

    -
    -
    returns
    -

    the current Option

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addChoice

    +
      +
    • addChoice(choices: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets the list of values accepted by this option. If the value set by the user does not match once of these + values, a {@link InvalidValueException} exception is thrown.

      +
      +
      +

      Parameters

      +
        +
      • +
        choices: string
        +
        +

        the choices

        +
        +
        • +
      +

      Returns Option

      +

      the current Option

      +
      • +
    -
    - -

    defaultValue

    -
    defaultValue: string
    - -
    -
    -

    Sets the default value of this option

    -
    -
    -
    param
    -

    the default value

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    getArgName

    +
      +
    • getArgName(): string
      • +
    +
      +
    • + +
      +
      +

      Sets te arg name for this option.

      +
      +
      +

      Returns string

      +

      the current Option instance

      +
      • +
    -
    - -

    description

    -
    description: string
    - -
    -
    -

    Sets te description of this option.

    -
    -
    -
    param
    -

    the description

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    getChoices

    +
      +
    • getChoices(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the list of values accepted by this option. If the value set by the user does not match once of these + values, a {@link InvalidValueException} exception is thrown.

      +
      +
      +

      Returns string

      +

      the current Option

      +
      • +
    -
    - -

    flag

    -
    flag: boolean
    - -
    -
    -

    Configures the current Option to be a flag. It will be evaluated to {@code true} if it's found in - the command line. If you need a flag that may receive a value, use, in this order: - 

    +				
    
+					
+					
    getDefaultValue
    
+					
      
+						
    • getDefaultValue(): string
      • 
+					
    
+					
      
+						
    • 
+							
+							
      
+								
      
+									
      Sets the default value of this option
      
+								
      
+							
      
+							
      Returns string
      
+							
      the current Option instance
      
+						
      • 
+					
    
+				
    
+				
    
+					
+					
    getDescription
    
+					
      
+						
    • getDescription(): string
      • 
+					
    
+					
      
+						
    • 
+							
+							
      
+								
      
+									
      Sets te description of this option.
      
+								
      
+							
      
+							
      Returns string
      
+							
      the current Option instance
      
+						
      • 
+					
    
+				
    
+				
    
+					
+					
    getLongName
    
+					
      
+						
    • getLongName(): string
      • 
+					
    
+					
      
+						
    • 
+							
+							
      
+								
      
+									
      Sets the long name of this option.
      
+								
      
+							
      
+							
      Returns string
      
+							
      the current Option instance
      
+						
      • 
+					
    
+				
    
+				
    
+					
+					
    getName
    
+					
      
+						
    • getName(): string
      • 
+					
    
+					
      
+						
    • 
+							
+							
      
+								
      
+									
      see
      
+									
      #ensureValidity()
      
+									
      
+								
      
+							
      
+							
      Returns string
      
+							
      the option name. It returns the long name if set, the short name otherwise. It cannot return {@code
+							null} for valid option
      
+						
      • 
+					
    
+				
    
+				
    
+					
+					
    getShortName
    
+					
      
+						
    • getShortName(): string
      • 
+					
    
+					
      
+						
    • 
+							
+							
      
+								
      
+									
      Sets the short name of this option.
      
+								
      
+							
      
+							
      Returns string
      
+							
      the current Option instance
      
+						
      • 
+					
    
+				
    
+				
    
+					
+					
    isFlag
    
+					
      
+						
    • isFlag(): boolean
      • 
+					
    
+					
      
+						
    • 
+							
+							
      
+								
      
+									
      Configures the current Option to be a flag. It will be evaluated to {@code true} if it's found in
+										the command line. If you need a flag that may receive a value, use, in this order:
+										
          option.setFlag(true).setSingleValued(true)
  
      
-						
      
-						
      
-							
      param
      
-							
      whether or not the option is a flag.
      
-							
      
-							
      returns
      
-							
      the current Option
      
-							
      
-						
      
-					
      
+
    +
    +

    Returns boolean

    +

    the current Option

    + +
    -
    - -

    help

    -
    help: boolean
    - -
    -
    -

    Sets whether or not this option is a "help" option

    -
    -
    -
    param
    -

    to set this option as a "Help" option

    -
    -
    returns
    -

    the current Option

    -
    -
    -
    +
    + +

    isHelp

    +
      +
    • isHelp(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option is a "help" option

      +
      +
      +

      Returns boolean

      +

      the current Option

      +
      • +
    -
    - -

    hidden

    -
    hidden: boolean
    - -
    -
    -

    Sets whether or not this option should be hidden

    -
    -
    -
    param
    -

    to make this option hidden, {@link false} otherwise

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    isHidden

    +
      +
    • isHidden(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option should be hidden

      +
      +
      +

      Returns boolean

      +

      the current Option instance

      +
      • +
    -
    - -

    longName

    -
    longName: string
    - -
    -
    -

    Sets the long name of this option.

    -
    -
    -
    param
    -

    the long name

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    isMultiValued

    +
      +
    • isMultiValued(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option can receive several values.

      +
      +
      +

      Returns boolean

      +

      the current Option instance

      +
      • +
    -
    - -

    multiValued

    -
    multiValued: boolean
    - -
    -
    -

    Sets whether or not this option can receive several values.

    -
    -
    -
    param
    -

    whether or not this option is multi-valued.

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    isRequired

    +
      +
    • isRequired(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option is mandatory.

      +
      +
      +

      Returns boolean

      +

      the current Option instance

      +
      • +
    -
    - -

    required

    -
    required: boolean
    - -
    -
    -

    Sets whether or not this option is mandatory.

    -
    -
    -
    param
    -

    to make this option mandatory, {@link false} otherwise

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    isSingleValued

    +
      +
    • isSingleValued(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option can receive a value.

      +
      +
      +

      Returns boolean

      +

      the current Option instance

      +
      • +
    -
    - -

    shortName

    -
    shortName: string
    - -
    -
    -

    Sets the short name of this option.

    -
    -
    -
    param
    -

    the short name

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    setArgName

    +
      +
    • setArgName(argName: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets te arg name for this option.

      +
      +
      +

      Parameters

      +
        +
      • +
        argName: string
        +
        +

        the arg name, must not be {@code null}

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    -
    - -

    singleValued

    -
    singleValued: boolean
    - -
    -
    -

    Sets whether or not this option can receive a value.

    -
    -
    -
    param
    -

    whether or not this option is single-valued.

    -
    -
    returns
    -

    the current Option instance

    -
    -
    -
    +
    + +

    setChoices

    +
      +
    • setChoices(choices: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets the list of values accepted by this option. If the value set by the user does not match once of these + values, a {@link InvalidValueException} exception is thrown.

      +
      +
      +

      Parameters

      +
        +
      • +
        choices: string
        +
        +

        the choices

        +
        +
        • +
      +

      Returns Option

      +

      the current Option

      +
      • +
    +
    +
    + +

    setDefaultValue

    +
      +
    • setDefaultValue(defaultValue: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets the default value of this option

      +
      +
      +

      Parameters

      +
        +
      • +
        defaultValue: string
        +
        +

        the default value

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setDescription

    +
      +
    • setDescription(description: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets te description of this option.

      +
      +
      +

      Parameters

      +
        +
      • +
        description: string
        +
        +

        the description

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setFlag

    +
      +
    • setFlag(flag: boolean): Option
      • +
    +
      +
    • + +
      +
      +

      Configures the current Option to be a flag. It will be evaluated to {@code true} if it's found in + the command line. If you need a flag that may receive a value, use, in this order: + 

      +   option.setFlag(true).setSingleValued(true)
+

      +
      +
      +

      Parameters

      +
        +
      • +
        flag: boolean
        +
        +

        whether or not the option is a flag.

        +
        +
        • +
      +

      Returns Option

      +

      the current Option

      +
      • +
    +
    +
    + +

    setHelp

    +
      +
    • setHelp(help: boolean): Option
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option is a "help" option

      +
      +
      +

      Parameters

      +
        +
      • +
        help: boolean
        +
        +

        to set this option as a "Help" option

        +
        +
        • +
      +

      Returns Option

      +

      the current Option

      +
      • +
    +
    +
    + +

    setHidden

    +
      +
    • setHidden(hidden: boolean): Option
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option should be hidden

      +
      +
      +

      Parameters

      +
        +
      • +
        hidden: boolean
        +
        +

        to make this option hidden, {@link false} otherwise

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setLongName

    +
      +
    • setLongName(longName: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets the long name of this option.

      +
      +
      +

      Parameters

      +
        +
      • +
        longName: string
        +
        +

        the long name

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setMultiValued

    +
      +
    • setMultiValued(multiValued: boolean): Option
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option can receive several values.

      +
      +
      +

      Parameters

      +
        +
      • +
        multiValued: boolean
        +
        +

        whether or not this option is multi-valued.

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setRequired

    +
      +
    • setRequired(required: boolean): Option
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option is mandatory.

      +
      +
      +

      Parameters

      +
        +
      • +
        required: boolean
        +
        +

        to make this option mandatory, {@link false} otherwise

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setShortName

    +
      +
    • setShortName(shortName: string): Option
      • +
    +
      +
    • + +
      +
      +

      Sets the short name of this option.

      +
      +
      +

      Parameters

      +
        +
      • +
        shortName: string
        +
        +

        the short name

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    +
    +
    + +

    setSingleValued

    +
      +
    • setSingleValued(singleValued: boolean): Option
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not this option can receive a value.

      +
      +
      +

      Parameters

      +
        +
      • +
        singleValued: boolean
        +
        +

        whether or not this option is single-valued.

        +
        +
        • +
      +

      Returns Option

      +

      the current Option instance

      +
      • +
    @@ -396,41 +899,86 @@

    singleValued

  • Option
    • diff --git a/docs/@vertx/core/classes/pemkeycertoptions.html b/docs/@vertx/core/classes/pemkeycertoptions.html index bb9f16369..a8ce031d6 100644 --- a/docs/@vertx/core/classes/pemkeycertoptions.html +++ b/docs/@vertx/core/classes/pemkeycertoptions.html @@ -77,206 +77,511 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +

    certPath

    -
    certPath: string
    - -
    -
    -

    Set the path of the first certificate, replacing the previous certificates paths

    -
    -
    -
    param
    -

    the path to the certificate

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    certPaths

    -
    certPaths: string
    - -
    -
    -

    Set all the paths to the certificates files

    -
    -
    -
    param
    -

    the paths to the certificates files

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • certPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the path of the first certificate, replacing the previous certificates paths

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +

    certValue

    -
    certValue: Buffer
    - -
    -
    -

    Set the first certificate as a buffer, replacing the previous certificates buffers

    -
    -
    -
    param
    -

    the first certificate as a buffer

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    + +
      +
    • + +
      +
      +

      Set the first certificate as a buffer, replacing the previous certificates buffers

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    certValues

    -
    certValues: Buffer
    - -
    -
    -

    Set all the certificates as a list of buffer

    -
    -
    -
    param
    -

    the certificates as a list of buffer

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getCertPaths

    +
      +
    • getCertPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Set all the paths to the certificates files

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getCertValues

    + +
      +
    • + +
      +
      +

      Set all the certificates as a list of buffer

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +
    + +

    getKeyPaths

    +
      +
    • getKeyPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Set all the paths to the keys files

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getKeyValues

    + +
      +
    • + +
      +
      +

      Set all the keys as a list of buffer

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +

    keyPath

    -
    keyPath: string
    - -
    -
    -

    Set the path of the first key file, replacing the keys paths

    -
    -
    -
    param
    -

    the path to the first key file

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    keyPaths

    -
    keyPaths: string
    - -
    -
    -

    Set all the paths to the keys files

    -
    -
    -
    param
    -

    the paths to the keys files

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • keyPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the path of the first key file, replacing the keys paths

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +

    keyValue

    -
    keyValue: Buffer
    - -
    -
    -

    Set the first key a a buffer, replacing the previous keys buffers

    -
    -
    -
    param
    -

    key as a buffer

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    + +
      +
    • + +
      +
      +

      Set the first key a a buffer, replacing the previous keys buffers

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyValues

    -
    keyValues: Buffer
    - -
    -
    -

    Set all the keys as a list of buffer

    -
    -
    -
    param
    -

    the keys as a list of buffer

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setCertPath

    + +
      +
    • + +
      +
      +

      Set the path of the first certificate, replacing the previous certificates paths

      +
      +
      +

      Parameters

      +
        +
      • +
        certPath: string
        +
        +

        the path to the certificate

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCertPaths

    + +
      +
    • + +
      +
      +

      Set all the paths to the certificates files

      +
      +
      +

      Parameters

      +
        +
      • +
        certPaths: string
        +
        +

        the paths to the certificates files

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCertValue

    + +
      +
    • + +
      +
      +

      Set the first certificate as a buffer, replacing the previous certificates buffers

      +
      +
      +

      Parameters

      +
        +
      • +
        certValue: Buffer
        +
        +

        the first certificate as a buffer

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setCertValues

    + +
      +
    • + +
      +
      +

      Set all the certificates as a list of buffer

      +
      +
      +

      Parameters

      +
        +
      • +
        certValues: Buffer
        +
        +

        the certificates as a list of buffer

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeyPath

    + +
      +
    • + +
      +
      +

      Set the path of the first key file, replacing the keys paths

      +
      +
      +

      Parameters

      +
        +
      • +
        keyPath: string
        +
        +

        the path to the first key file

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeyPaths

    + +
      +
    • + +
      +
      +

      Set all the paths to the keys files

      +
      +
      +

      Parameters

      +
        +
      • +
        keyPaths: string
        +
        +

        the paths to the keys files

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeyValue

    + +
      +
    • + +
      +
      +

      Set the first key a a buffer, replacing the previous keys buffers

      +
      +
      +

      Parameters

      +
        +
      • +
        keyValue: Buffer
        +
        +

        key as a buffer

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeyValues

    + +
      +
    • + +
      +
      +

      Set all the keys as a list of buffer

      +
      +
      +

      Parameters

      +
        +
      • +
        keyValues: Buffer
        +
        +

        the keys as a list of buffer

        +
        +
        • +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -295,29 +600,56 @@

    keyValues

  • PemKeyCertOptions
    • diff --git a/docs/@vertx/core/classes/pemtrustoptions.html b/docs/@vertx/core/classes/pemtrustoptions.html index 70d84b080..725a21f5a 100644 --- a/docs/@vertx/core/classes/pemtrustoptions.html +++ b/docs/@vertx/core/classes/pemtrustoptions.html @@ -77,68 +77,183 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    certPaths

    -
    certPaths: string
    - -
    -
    -

    Add a certificate path

    -
    -
    -
    param
    -

    the path to add

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    certValues

    -
    certValues: Buffer
    - -
    -
    -

    Add a certificate value

    -
    -
    -
    param
    -

    the value to add

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCertPath

    + +
      +
    • + +
      +
      +

      Add a certificate path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        certPaths: string
        +
        • +
      +

      Returns PemTrustOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    addCertValue

    + +
      +
    • + +
      +
      +

      Add a certificate value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Parameters

      + +

      Returns PemTrustOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getCertPaths

    +
      +
    • getCertPaths(): string
      • +
    +
      +
    • + +
      +
      +

      Add a certificate path

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getCertValues

    + +
      +
    • + +
      +
      +

      Add a certificate value

      +
      +
      +
      throws
      +

      NullPointerException

      +
      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -157,11 +272,20 @@

    certValues

  • PemTrustOptions
    • diff --git a/docs/@vertx/core/classes/pfxoptions.html b/docs/@vertx/core/classes/pfxoptions.html index 493854c8a..fc01a0c40 100644 --- a/docs/@vertx/core/classes/pfxoptions.html +++ b/docs/@vertx/core/classes/pfxoptions.html @@ -77,86 +77,226 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Set the password

    -
    -
    -
    param
    -

    the password

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns PfxOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns PfxOptions

      +
      • +
    -
    - -

    path

    -
    path: string
    - -
    -
    -

    Set the path

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Set the password

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    value

    -
    value: Buffer
    - -
    -
    -

    Set the store as a buffer

    -
    -
    -
    param
    -

    the store as a buffer

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPath

    +
      +
    • getPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the path

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getValue

    + +
      +
    • + +
      +
      +

      Set the store as a buffer

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Set the password

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        +

        the password

        +
        +
        • +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPath

    + +
      +
    • + +
      +
      +

      Set the path

      +
      +
      +

      Parameters

      +
        +
      • +
        path: string
        +
        +

        the path

        +
        +
        • +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setValue

    + +
      +
    • + +
      +
      +

      Set the store as a buffer

      +
      +
      +

      Parameters

      +
        +
      • +
        value: Buffer
        +
        +

        the store as a buffer

        +
        +
        • +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -175,14 +315,26 @@

    value

  • PfxOptions
    • diff --git a/docs/@vertx/core/classes/proxyoptions.html b/docs/@vertx/core/classes/proxyoptions.html index 2bfe90b77..612945b98 100644 --- a/docs/@vertx/core/classes/proxyoptions.html +++ b/docs/@vertx/core/classes/proxyoptions.html @@ -77,135 +77,342 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set proxy host.

    -
    -
    -
    param
    -

    the proxy host to connect to

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Set proxy password.

    -
    -
    -
    param
    -

    the proxy password

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set proxy host.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set proxy port.

    -
    -
    -
    param
    -

    the proxy port to connect to

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Set proxy password.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    type

    -
    type: ProxyType
    - -
    -
    -

    Set proxy type.

    -
    -

    ProxyType can be HTTP, SOCKS4 and SOCKS5 -

    -
    param
    -

    the proxy type to connect to

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set proxy port.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    username

    -
    username: string
    - -
    -
    -

    Set proxy username.

    -
    -
    -
    param
    -

    the proxy username

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getType

    + +
      +
    • + +
      +
      +

      Set proxy type.

      +
      +

      ProxyType can be HTTP, SOCKS4 and SOCKS5 +

      +

      Returns ProxyType

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getUsername

    +
      +
    • getUsername(): string
      • +
    +
      +
    • + +
      +
      +

      Set proxy username.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set proxy host.

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the proxy host to connect to

        +
        +
        • +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Set proxy password.

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        +

        the proxy password

        +
        +
        • +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set proxy port.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the proxy port to connect to

        +
        +
        • +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +
      +
      +

      Set proxy type.

      +
      +

      ProxyType can be HTTP, SOCKS4 and SOCKS5 +

      +

      Parameters

      +
        +
      • +
        type: ProxyType
        +
        +

        the proxy type to connect to

        +
        +
        • +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setUsername

    + +
      +
    • + +
      +
      +

      Set proxy username.

      +
      +
      +

      Parameters

      +
        +
      • +
        username: string
        +
        +

        the proxy username

        +
        +
        • +
      +

      Returns ProxyOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -224,20 +431,38 @@

    username

  • ProxyOptions
    • diff --git a/docs/@vertx/core/classes/pump.html b/docs/@vertx/core/classes/pump.html index cc878ba33..a53b8a2bc 100644 --- a/docs/@vertx/core/classes/pump.html +++ b/docs/@vertx/core/classes/pump.html @@ -83,7 +83,7 @@

    Methods

  • setWriteQueueMaxSize
  • start
  • stop
    • -
  • pump
    • +
  • pump
    • @@ -101,12 +101,12 @@

    numberPumped

  • -

    Return the total number of items pumped by this pump.

    +

    Return the total number of items pumped by this pump.

    Returns number

    @@ -123,12 +123,12 @@

    setWriteQueueMaxSize

  • -

    Set the write queue max size to {@code maxSize}

    +

    Set the write queue max size to {@code maxSize}

    Parameters

    @@ -155,12 +155,12 @@

    start

  • -

    Start the Pump. The Pump can be started and stopped multiple times.

    +

    Start the Pump. The Pump can be started and stopped multiple times.

    Returns Pump

    @@ -178,12 +178,12 @@

    stop

  • -

    Stop the Pump. The Pump can be started and stopped multiple times.

    +

    Stop the Pump. The Pump can be started and stopped multiple times.

    Returns Pump

    @@ -191,35 +191,41 @@

    Returns +

    Static pump

    -
    +
    +

    Implements

    + +

    Index

    @@ -82,6 +89,7 @@

    Methods

  • delimitedMode
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • fixedSizeMode
  • handle
  • handler
    • @@ -109,12 +117,12 @@

    delimitedMode

  • -

    Flip the parser into delimited mode, and where the delimiter can be represented +

    Flip the parser into delimited mode, and where the delimiter can be represented by the String {@code delim} encoded in latin-1 . Don't use this if your String contains other than latin-1 characters.

    This method can be called multiple times with different values of delim while data is being parsed.

    @@ -134,12 +142,12 @@

    Returns void
    -

    Flip the parser into delimited mode, and where the delimiter can be represented +

    Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter {@code delim}.

    This method can be called multiple times with different values of delim while data is being parsed.

    @@ -168,7 +176,7 @@

    endHandler

  • Parameters

    @@ -178,17 +186,19 @@
    endHandler: function
      • -
      • (result: void): void | null | undefined
        • +
      • (res: void): void | Handler<void> | null | undefined

      • Parameters

        • -
          result: void
          +
          res: void

        Returns void + | + Handler<void> | null | @@ -214,7 +224,7 @@

        exceptionHandler

      • Parameters

        @@ -224,17 +234,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -250,6 +262,30 @@

            Returns + +

            fetch

            + +
              +
            • + +

              Parameters

              +
                +
              • +
                amount: number
                +
                • +
              +

              Returns RecordParser

              +
              • +
            +

    • fixedSizeMode

    @@ -260,12 +296,12 @@

    fixedSizeMode

  • -

    Flip the parser into fixed size mode, where the record size is specified by {@code size} in bytes. +

    Flip the parser into fixed size mode, where the record size is specified by {@code size} in bytes.

    This method can be called multiple times with different values of size while data is being parsed.

    @@ -293,12 +329,12 @@

    handle

  • -

    This method is called to provide the parser with data.

    +

    This method is called to provide the parser with data.

    Parameters

    @@ -324,7 +360,7 @@

    handler

  • Parameters

    @@ -334,17 +370,19 @@
    handler: function
    • -

    Properties

    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the host name to be used by the client request.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port to be used by the client request.

    -
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the host name to be used by the client request.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set whether SSL/TLS is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port to be used by the client request.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    uri

    -
    uri: string
    - -
    -
    -

    Set the request relative URI

    -
    -
    -
    param
    -

    the relative uri

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getURI

    +
      +
    • getURI(): string
      • +
    +
      +
    • + +
      +
      +

      Set the request relative URI

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set the host name to be used by the client request.

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns RequestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the port to be used by the client request.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        • +
      +

      Returns RequestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Set whether SSL/TLS is enabled

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        true if enabled

        +
        +
        • +
      +

      Returns RequestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setURI

    + +
      +
    • + +
      +
      +

      Set the request relative URI

      +
      +
      +

      Parameters

      +
        +
      • +
        uri: string
        +
        +

        the relative uri

        +
        +
        • +
      +

      Returns RequestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -193,17 +366,32 @@

    uri

  • RequestOptions
    • diff --git a/docs/@vertx/core/classes/selfsignedcertificate.html b/docs/@vertx/core/classes/selfsignedcertificate.html index 962622ab3..71efee378 100644 --- a/docs/@vertx/core/classes/selfsignedcertificate.html +++ b/docs/@vertx/core/classes/selfsignedcertificate.html @@ -102,12 +102,12 @@

    certificatePath

  • -

    Filesystem path to the X.509 certificate file in PEM format .

    +

    Filesystem path to the X.509 certificate file in PEM format .

    Returns string

    @@ -125,12 +125,12 @@

    delete

  • -

    Delete the private key and certificate files.

    +

    Delete the private key and certificate files.

    Returns void

    @@ -147,12 +147,12 @@

    keyCertOptions

  • -

    Provides the {@link KeyCertOptions} RSA private key file in PEM format corresponding to the {@link #privateKeyPath()}

    +

    Provides the {@link KeyCertOptions} RSA private key file in PEM format corresponding to the {@link #privateKeyPath()}

    Returns PemKeyCertOptions

    @@ -170,12 +170,12 @@

    privateKeyPath

  • -

    Filesystem path to the RSA private key file in PEM format

    +

    Filesystem path to the RSA private key file in PEM format

    Returns string

    @@ -193,12 +193,12 @@

    trustOptions

  • -

    Provides the {@link TrustOptions} X.509 certificate file in PEM format corresponding to the {@link #certificatePath()}

    +

    Provides the {@link TrustOptions} X.509 certificate file in PEM format corresponding to the {@link #certificatePath()}

    Returns PemTrustOptions

    @@ -217,12 +217,12 @@

    Static create

  • -

    Create a new {@code SelfSignedCertificate} instance.

    +

    Create a new {@code SelfSignedCertificate} instance.

    Returns SelfSignedCertificate

    @@ -231,12 +231,12 @@

    Returns
    -

    Create a new {@code SelfSignedCertificate} instance with a fully-qualified domain name,

    +

    Create a new {@code SelfSignedCertificate} instance with a fully-qualified domain name,

    Parameters

    diff --git a/docs/@vertx/core/classes/serverwebsocket.html b/docs/@vertx/core/classes/serverwebsocket.html index 3e88bc7f3..ec51a9faa 100644 --- a/docs/@vertx/core/classes/serverwebsocket.html +++ b/docs/@vertx/core/classes/serverwebsocket.html @@ -72,6 +72,12 @@

    Hierarchy

    • +
    +

    Implements

    +     +

    Index

    @@ -88,6 +94,7 @@

    Methods

  • end
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • frameHandler
  • handler
  • headers
    • @@ -131,12 +138,12 @@

    accept

  • -

    Accept the WebSocket and terminate the WebSocket handshake. +

    Accept the WebSocket and terminate the WebSocket handshake.

    This method should be called from the websocket handler to explicitely accept the websocker and terminate the WebSocket handshake.

    @@ -155,13 +162,14 @@

    binaryHandlerID

    • -

      When a {@code Websocket} is created it automatically registers an event handler with the event bus - the ID of that +

      When a {@code Websocket} is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

      Given this ID, a different event loop can send a binary frame to that event handler using the event bus and @@ -184,12 +192,12 @@

      binaryMessageHandler

    • -

      Set a binary message handler on the connection. This handler serves a similar purpose to {@link #handler(Handler)} +

      Set a binary message handler on the connection. This handler serves a similar purpose to {@link #handler(Handler)} except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using {@link WebSocketFrame#isFinal()} to find the boundaries).

      @@ -204,17 +212,19 @@
      handler: function

        • Parameters

          Returns void + | + Handler<Buffer> | null | @@ -242,21 +252,25 @@

          close

          • -

            Close the WebSocket.

            +

            Close the WebSocket sending the default close frame. +

            + No more messages can be sent.

            Returns void

          • Parameters

            @@ -269,8 +283,9 @@

            Returns void

          • Parameters

            @@ -296,7 +311,7 @@

            closeHandler

          • Parameters

            @@ -306,17 +321,19 @@
            handler: function
              • -
              • (result: void): void | null | undefined
                • +
              • (res: void): void | Handler<void> | null | undefined

              • Parameters

                • -
                  result: void
                  +
                  res: void

                Returns void + | + Handler<void> | null | @@ -342,7 +359,7 @@

                drainHandler

              • Parameters

                @@ -352,17 +369,19 @@
                handler: function
                  • -
                  • (result: void): void | null | undefined
                    • +
                  • (res: void): void | Handler<void> | null | undefined

                  • Parameters

                    • -
                      result: void
                      +
                      res: void

                    Returns void + | + Handler<void> | null | @@ -388,13 +407,14 @@

                    end

                    • -

                      Same as {@link #end()} but writes some data to the stream before ending.

                      +

                      Same as {@link #end()} but writes some data to the stream before ending.

                      Parameters

                      @@ -407,13 +427,14 @@

                      Returns void
                    • -

                      Calls {@link #close()}

                      +

                      Calls {@link #close()}

                      Returns void

                      @@ -430,7 +451,7 @@

                      endHandler

                    • Parameters

                      @@ -440,17 +461,19 @@
                      endHandler: function
                        • -
                        • (result: void): void | null | undefined
                          • +
                        • (res: void): void | Handler<void> | null | undefined

                        • Parameters

                          • -
                            result: void
                            +
                            res: void

                          Returns void + | + Handler<void> | null | @@ -476,7 +499,7 @@

                          exceptionHandler

                        • Parameters

                          @@ -486,17 +509,19 @@
                          handler: function
                            • -
                            • (result: Error): void | null | undefined
                              • +
                            • (res: Error): void | Handler<Error> | null | undefined

                            • Parameters

                              • -
                                result: Error
                                +
                                res: Error

                              Returns void + | + Handler<Error> | null | @@ -512,6 +537,30 @@

                              Returns + +

                              fetch

                              + + +

    • frameHandler

    @@ -522,7 +571,7 @@

    frameHandler

  • Parameters

    @@ -532,17 +581,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<WebSocketFrame> | null | @@ -568,7 +619,7 @@

        handler

      • Parameters

        @@ -578,17 +629,19 @@
        handler: function

          • Parameters

            Returns void + | + Handler<Buffer> | null | @@ -614,7 +667,7 @@

            headers

          • @@ -633,8 +686,9 @@

            isSsl

            • @@ -653,8 +707,9 @@

              localAddress

              • @@ -674,7 +729,7 @@

                path

              • @@ -693,8 +748,9 @@

                pause

                • Returns ServerWebSocket

                  @@ -711,12 +767,12 @@

                  pongHandler

                • -

                  Set a pong message handler on the connection. This handler will be invoked every time a pong message is received +

                  Set a pong message handler on the connection. This handler will be invoked every time a pong message is received on the server, and can be used by both clients and servers since the RFC 6455 Sections 5.5.2 and 5.5.3 do not specify whether the client or server sends a ping.

                  @@ -737,17 +793,19 @@

                  handler: function

                    • Parameters

                      Returns void + | + Handler<Buffer> | null | @@ -774,7 +832,7 @@

                      query

                    • @@ -798,12 +856,12 @@

                      reject

                    • -

                      Reject the WebSocket. +

                      Reject the WebSocket.

                      Calling this method from the websocket handler when it is first passed to you gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning @@ -817,12 +875,12 @@

                      Returns void
                      -

                      Like {@link #reject()} but with a {@code status}.

                      +

                      Like {@link #reject()} but with a {@code status}.

                      Parameters

                      @@ -844,8 +902,9 @@

                      remoteAddress

                      • @@ -864,8 +923,9 @@

                        resume

                        • Returns ServerWebSocket

                          @@ -881,8 +941,9 @@

                          setWriteQueueMaxSize

                          • Parameters

                            @@ -904,13 +965,14 @@

                            subProtocol

                            • -

                              Returns the websocket sub protocol selected by the websocket handshake. +

                              Returns the websocket sub protocol selected by the websocket handshake.

                              On the server, the value will be {@code null} when the handler receives the websocket callback as the handshake will not be completed yet.

                              @@ -929,13 +991,14 @@

                              textHandlerID

                              • -

                                When a {@code Websocket} is created it automatically registers an event handler with the eventbus, the ID of that +

                                When a {@code Websocket} is created it automatically registers an event handler with the eventbus, the ID of that handler is given by {@code textHandlerID}.

                                Given this ID, a different event loop can send a text frame to that event handler using the event bus and @@ -957,12 +1020,12 @@

                                textMessageHandler

                              • -

                                Set a text message handler on the connection. This handler will be called similar to the +

                                Set a text message handler on the connection. This handler will be called similar to the {@link #binaryMessageHandler(Handler)}, but the buffer will be converted to a String first

                                @@ -976,17 +1039,19 @@
                                handler: function
                                  • -
                                  • (result: string): void | null | undefined
                                    • +
                                  • (res: string): void | Handler<string> | null | undefined

                                  • Parameters

                                    • -
                                      result: string
                                      +
                                      res: string

                                    Returns void + | + Handler<string> | null | @@ -1013,7 +1078,7 @@

                                    uri

                                  • Returns string

                                    @@ -1029,8 +1094,9 @@

                                    write

                                    • Parameters

                                      @@ -1052,8 +1118,9 @@

                                      writeBinaryMessage

                                      • Parameters

                                        @@ -1075,8 +1142,9 @@

                                        writeFinalBinaryFrame

                                        • Parameters

                                          @@ -1098,8 +1166,9 @@

                                          writeFinalTextFrame

                                          • Parameters

                                            @@ -1121,8 +1190,9 @@

                                            writeFrame

                                            • Parameters

                                              @@ -1144,13 +1214,14 @@

                                              writePing

                                              • -

                                                Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets). +

                                                Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

                                                This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2. @@ -1182,13 +1253,14 @@

                                                writePong

                                                • -

                                                  Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets). +

                                                  Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

                                                  This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2. @@ -1221,13 +1293,14 @@

                                                  writeQueueFull

                                                  • -

                                                    This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                                    +

                                                    This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                                    #setWriteQueueMaxSize}

                                                    @@ -1245,13 +1318,14 @@

                                                    writeTextMessage

                                                    • -

                                                      Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames +

                                                      Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

                                                      @@ -1313,6 +1387,9 @@

                                                      Returns exceptionHandler

                                                      • +
                                                    • + fetch +
                                                    • frameHandler
                                                      • diff --git a/docs/@vertx/core/classes/shareddata.html b/docs/@vertx/core/classes/shareddata.html index a90de6c1a..c29df81c5 100644 --- a/docs/@vertx/core/classes/shareddata.html +++ b/docs/@vertx/core/classes/shareddata.html @@ -79,10 +79,10 @@

                                                      Index

                                                      Methods

                                                      @@ -92,22 +92,22 @@

                                                      Methods

                                                      Methods

                                                      -
                                                      +

                                                      getAsyncMap

                                                      -
                                                        -
                                                      • getAsyncMap(name: string, resultHandler: function): void
                                                        • +
                                                          +
                                                        • getAsyncMap<K, V>(name: string, resultHandler: function): void
                                                        • -

                                                          Get the AsyncMap with the specified name. When clustered, the map is accessible to all nodes in the cluster +

                                                          Get the AsyncMap with the specified name. When clustered, the map is accessible to all nodes in the cluster and data put into the map from any node is visible to to any other node.

                                                          WARNING: In clustered mode, asynchronous shared maps rely on distributed data structures provided by the cluster manager. @@ -115,6 +115,15 @@

                                                          getAsyncMap

                                                          +

                                                          Type parameters

                                                          +
                                                            +
                                                          • +

                                                            K

                                                            +
                                                            • +
                                                          • +

                                                            V

                                                            +
                                                            • +

                                                          Parameters

                                                      -
                                                      +

                                                      getClusterWideMap

                                                      -
                                                        -
                                                      • getClusterWideMap(name: string, resultHandler: function): void
                                                        • +
                                                          +
                                                        • getClusterWideMap<K, V>(name: string, resultHandler: function): void
                                                        • -

                                                          Get the cluster wide map with the specified name. The map is accessible to all nodes in the cluster and data +

                                                          Get the cluster wide map with the specified name. The map is accessible to all nodes in the cluster and data put into the map from any node is visible to to any other node.

                                                          @@ -176,6 +188,15 @@

                                                          getClusterWideMap

                                                          +

                                                          Type parameters

                                                          +
                                                            +
                                                          • +

                                                            K

                                                            +
                                                            • +
                                                          • +

                                                            V

                                                            +
                                                            • +

                                                          Parameters

                                                      -
                                                      +

                                                      getLocalMap

                                                      -
                                                        -
                                                      • getLocalMap(name: string): LocalMap
                                                        • +
                                                          +
                                                        • getLocalMap<K, V>(name: string): LocalMap<K, V>
                                                        • -

                                                          Return a {@code LocalMap} with the specific {@code name}.

                                                          +

                                                          Return a {@code LocalMap} with the specific {@code name}.

                                                          +

                                                          Type parameters

                                                          +
                                                            +
                                                          • +

                                                            K

                                                            +
                                                            • +
                                                          • +

                                                            V

                                                            +
                                                            • +

                                                          Parameters

                                                          • @@ -295,7 +331,7 @@
                                                            name: string
                                                -

                                                Returns LocalMap

                                                +

                                                Returns LocalMap<K, V>

                                                the msp

                                              @@ -310,12 +346,16 @@

                                              getLock

                                            • -

                                              Get an asynchronous lock with the specified name. The lock will be passed to the handler when it is available.

                                              +

                                              Get an asynchronous lock with the specified name. The lock will be passed to the handler when it is available. +

                                              + In general lock acquision is unordered, so that sequential attempts to acquire a lock, + even from a single thread, can happen in non-sequential order. +

                                              Parameters

                                              @@ -334,17 +374,20 @@
                                              resultHandler: function
                                                • @@ -365,13 +408,17 @@

                                                getLockWithTimeout

                                              • -

                                                Like {@link #getLock(String, Handler)} but specifying a timeout. If the lock is not obtained within the timeout - a failure will be sent to the handler

                                                +

                                                Like {@link #getLock(String, Handler)} but specifying a timeout. If the lock is not obtained within the timeout + a failure will be sent to the handler. +

                                                + In general lock acquision is unordered, so that sequential attempts to acquire a lock, + even from a single thread, can happen in non-sequential order. +

                                                Parameters

                                                @@ -396,17 +443,20 @@
                                                resultHandler: function
                                                  • @@ -434,16 +484,16 @@

                                                  Returns void SharedData
                                                    -
                                                  • +
                                                  • getAsyncMap
                                                    • -
                                                  • +
                                                  • getClusterWideMap
                                                  • getCounter
                                                    • -
                                                  • +
                                                  • getLocalMap
                                                  • diff --git a/docs/@vertx/core/classes/socketaddress.html b/docs/@vertx/core/classes/socketaddress.html index 7d0661b61..6af6bb303 100644 --- a/docs/@vertx/core/classes/socketaddress.html +++ b/docs/@vertx/core/classes/socketaddress.html @@ -101,7 +101,7 @@

                                                    host

                                                  • @@ -121,7 +121,7 @@

                                                    path

                                                  • @@ -141,7 +141,7 @@

                                                    port

                                                  • @@ -161,12 +161,12 @@

                                                    Static domainSocketAdd
                                                  • -

                                                    Create a domain socket address.

                                                    +

                                                    Create a domain socket address.

                                                    Parameters

                                                    @@ -193,12 +193,12 @@

                                                    Static inetSocketAddre
                                                  • -

                                                    Create a inet socket address, {@code host} must be non {@code null} and {@code port} must be between {@code 0} +

                                                    Create a inet socket address, {@code host} must be non {@code null} and {@code port} must be between {@code 0} and {@code 65536}.

                                                    diff --git a/docs/@vertx/core/classes/srvrecord.html b/docs/@vertx/core/classes/srvrecord.html index 936cf0727..1c33d8ef7 100644 --- a/docs/@vertx/core/classes/srvrecord.html +++ b/docs/@vertx/core/classes/srvrecord.html @@ -103,12 +103,12 @@

                                                    name

                                                  • -

                                                    Returns the name for the server being queried.

                                                    +

                                                    Returns the name for the server being queried.

                                                    Returns string

                                                    @@ -125,12 +125,12 @@

                                                    port

                                                  • -

                                                    Returns the port the service is running on.

                                                    +

                                                    Returns the port the service is running on.

                                                    Returns number

                                                    @@ -147,12 +147,12 @@

                                                    priority

                                                  • -

                                                    Returns the priority for this service record.

                                                    +

                                                    Returns the priority for this service record.

                                                    Returns number

                                                    @@ -169,12 +169,12 @@

                                                    protocol

                                                  • -

                                                    Returns the protocol for the service being queried (i.e. "_tcp").

                                                    +

                                                    Returns the protocol for the service being queried (i.e. "_tcp").

                                                    Returns string

                                                    @@ -191,12 +191,12 @@

                                                    service

                                                  • -

                                                    Returns the service's name (i.e. "_http").

                                                    +

                                                    Returns the service's name (i.e. "_http").

                                                    Returns string

                                                    @@ -213,12 +213,12 @@

                                                    target

                                                  • -

                                                    Returns the name of the host for the service.

                                                    +

                                                    Returns the name of the host for the service.

                                                    Returns string @@ -238,12 +238,12 @@

                                                    weight

                                                  • -

                                                    Returns the weight of this service record.

                                                    +

                                                    Returns the weight of this service record.

                                                    Returns number

                                                    diff --git a/docs/@vertx/core/classes/streampriority.html b/docs/@vertx/core/classes/streampriority.html new file mode 100644 index 000000000..8523b4f8b --- /dev/null +++ b/docs/@vertx/core/classes/streampriority.html @@ -0,0 +1,414 @@ + + + + + + StreamPriority | @vertx/core + + + + + +
                                                    +
                                                    +
                                                    +
                                                    + +
                                                    +
                                                    + Options +
                                                    +
                                                    + All +
                                                      +
                                                    • Public
                                                      • +
                                                    • Public/Protected
                                                      • +
                                                    • All
                                                      • +
                                                    +
                                                    + + + + +
                                                    +
                                                    + Menu +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + +

                                                    Class StreamPriority

                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Hierarchy

                                                    +
                                                      +
                                                    • + StreamPriority +
                                                      • +
                                                    +
                                                    +
                                                    +

                                                    Index

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Constructors

                                                    + +
                                                    +
                                                    +

                                                    Methods

                                                    + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Constructors

                                                    +
                                                    + +

                                                    constructor

                                                    + + +
                                                    +
                                                    +
                                                    +

                                                    Methods

                                                    +
                                                    + +

                                                    getDependency

                                                    +
                                                      +
                                                    • getDependency(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the priority dependency value.

                                                      +
                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getWeight

                                                    +
                                                      +
                                                    • getWeight(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the priority weight.

                                                      +
                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isExclusive

                                                    +
                                                      +
                                                    • isExclusive(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the priority exclusive value.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setDependency

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the priority dependency value.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        dependency: number
                                                        +
                                                        +

                                                        the new value

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns StreamPriority

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setExclusive

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the priority exclusive value.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        exclusive: boolean
                                                        +
                                                        +

                                                        the new value

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns StreamPriority

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setWeight

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the priority weight.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        weight: number
                                                        +
                                                        +

                                                        the new value

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns StreamPriority

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Legend

                                                    +
                                                    +
                                                      +
                                                    • Module
                                                      • +
                                                    • Object literal
                                                      • +
                                                    • Variable
                                                      • +
                                                    • Function
                                                      • +
                                                    • Function with type parameter
                                                      • +
                                                    • Index signature
                                                      • +
                                                    • Type alias
                                                      • +
                                                    +
                                                      +
                                                    • Enumeration
                                                      • +
                                                    • Enumeration member
                                                      • +
                                                    • Property
                                                      • +
                                                    • Method
                                                      • +
                                                    +
                                                      +
                                                    • Interface
                                                      • +
                                                    • Interface with type parameter
                                                      • +
                                                    • Constructor
                                                      • +
                                                    • Property
                                                      • +
                                                    • Method
                                                      • +
                                                    • Index signature
                                                      • +
                                                    +
                                                      +
                                                    • Class
                                                      • +
                                                    • Class with type parameter
                                                      • +
                                                    • Constructor
                                                      • +
                                                    • Property
                                                      • +
                                                    • Method
                                                      • +
                                                    • Accessor
                                                      • +
                                                    • Index signature
                                                      • +
                                                    +
                                                      +
                                                    • Inherited constructor
                                                      • +
                                                    • Inherited property
                                                      • +
                                                    • Inherited method
                                                      • +
                                                    • Inherited accessor
                                                      • +
                                                    +
                                                      +
                                                    • Protected property
                                                      • +
                                                    • Protected method
                                                      • +
                                                    • Protected accessor
                                                      • +
                                                    +
                                                      +
                                                    • Private property
                                                      • +
                                                    • Private method
                                                      • +
                                                    • Private accessor
                                                      • +
                                                    +
                                                      +
                                                    • Static property
                                                      • +
                                                    • Static method
                                                      • +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Generated using TypeDoc

                                                    +
                                                    +
                                                    + + + + \ No newline at end of file diff --git a/docs/@vertx/core/classes/tcpssloptions.html b/docs/@vertx/core/classes/tcpssloptions.html new file mode 100644 index 000000000..6750cbf12 --- /dev/null +++ b/docs/@vertx/core/classes/tcpssloptions.html @@ -0,0 +1,2061 @@ + + + + + + TCPSSLOptions | @vertx/core + + + + + +
                                                    +
                                                    +
                                                    +
                                                    + +
                                                    +
                                                    + Options +
                                                    +
                                                    + All +
                                                      +
                                                    • Public
                                                      • +
                                                    • Public/Protected
                                                      • +
                                                    • All
                                                      • +
                                                    +
                                                    + + + + +
                                                    +
                                                    + Menu +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + +

                                                    Class TCPSSLOptions

                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Hierarchy

                                                    +
                                                      +
                                                    • + TCPSSLOptions +
                                                      • +
                                                    +
                                                    +
                                                    +

                                                    Index

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Constructors

                                                    + +
                                                    +
                                                    +

                                                    Methods

                                                    + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Constructors

                                                    +
                                                    + +

                                                    constructor

                                                    + + +
                                                    +
                                                    +
                                                    +

                                                    Methods

                                                    +
                                                    + +

                                                    addCrlPath

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Add a CRL path

                                                      +
                                                      +
                                                      +
                                                      throws
                                                      +

                                                      NullPointerException

                                                      +
                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        crlPaths: string
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    addCrlValue

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Add a CRL value

                                                      +
                                                      +
                                                      +
                                                      throws
                                                      +

                                                      NullPointerException

                                                      +
                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    addEnabledCipherSuite

                                                    +
                                                      +
                                                    • addEnabledCipherSuite(enabledCipherSuites: string): TCPSSLOptions
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Add an enabled cipher suite, appended to the ordered suites.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        enabledCipherSuites: string
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    addEnabledSecureTransportProtocol

                                                    +
                                                      +
                                                    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): TCPSSLOptions
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Sets the list of enabled SSL/TLS protocols.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        enabledSecureTransportProtocols: string
                                                        +
                                                        +

                                                        the SSL/TLS protocols to enable

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getCrlPaths

                                                    +
                                                      +
                                                    • getCrlPaths(): string
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Add a CRL path

                                                      +
                                                      +
                                                      +
                                                      throws
                                                      +

                                                      NullPointerException

                                                      +
                                                      +
                                                      +
                                                      +

                                                      Returns string

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getCrlValues

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Add a CRL value

                                                      +
                                                      +
                                                      +
                                                      throws
                                                      +

                                                      NullPointerException

                                                      +
                                                      +
                                                      +
                                                      +

                                                      Returns Buffer

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getEnabledCipherSuites

                                                    +
                                                      +
                                                    • getEnabledCipherSuites(): string
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Add an enabled cipher suite, appended to the ordered suites.

                                                      +
                                                      +
                                                      +

                                                      Returns string

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getEnabledSecureTransportProtocols

                                                    +
                                                      +
                                                    • getEnabledSecureTransportProtocols(): string
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Sets the list of enabled SSL/TLS protocols.

                                                      +
                                                      +
                                                      +

                                                      Returns string

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getIdleTimeout

                                                    +
                                                      +
                                                    • getIdleTimeout(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

                                                      +
                                                      +

                                                      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getIdleTimeoutUnit

                                                    +
                                                      +
                                                    • getIdleTimeoutUnit(): any
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the idle timeout unit. If not specified, default is seconds.

                                                      +
                                                      +
                                                      +

                                                      Returns any

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getJdkSslEngineOptions

                                                    + + +
                                                    +
                                                    + +

                                                    getKeyStoreOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the key/cert options in jks format, aka Java keystore.

                                                      +
                                                      +
                                                      +

                                                      Returns JksOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getLogActivity

                                                    +
                                                      +
                                                    • getLogActivity(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getOpenSslEngineOptions

                                                    + + +
                                                    +
                                                    + +

                                                    getPemKeyCertOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the key/cert store options in pem format.

                                                      +
                                                      +
                                                      +

                                                      Returns PemKeyCertOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getPemTrustOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the trust options in pem format

                                                      +
                                                      +
                                                      +

                                                      Returns PemTrustOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getPfxKeyCertOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the key/cert options in pfx format.

                                                      +
                                                      +
                                                      +

                                                      Returns PfxOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getPfxTrustOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the trust options in pfx format

                                                      +
                                                      +
                                                      +

                                                      Returns PfxOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getReceiveBufferSize

                                                    +
                                                      +
                                                    • getReceiveBufferSize(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the TCP receive buffer size

                                                      +
                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getSendBufferSize

                                                    +
                                                      +
                                                    • getSendBufferSize(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the TCP send buffer size

                                                      +
                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getSoLinger

                                                    +
                                                      +
                                                    • getSoLinger(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether SO_linger keep alive is enabled

                                                      +
                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getTrafficClass

                                                    +
                                                      +
                                                    • getTrafficClass(): number
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the value of traffic class

                                                      +
                                                      +
                                                      +

                                                      Returns number

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    getTrustStoreOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the trust options in jks format, aka Java truststore

                                                      +
                                                      +
                                                      +

                                                      Returns JksOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isReuseAddress

                                                    +
                                                      +
                                                    • isReuseAddress(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the value of reuse address

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isReusePort

                                                    +
                                                      +
                                                    • isReusePort(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the value of reuse port. +

                                                      + This is only supported by native transports.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isSsl

                                                    +
                                                      +
                                                    • isSsl(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether SSL/TLS is enabled

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isTcpCork

                                                    +
                                                      +
                                                    • isTcpCork(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Enable the {@code TCP_CORK} option - only with linux native transport.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isTcpFastOpen

                                                    +
                                                      +
                                                    • isTcpFastOpen(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isTcpKeepAlive

                                                    +
                                                      +
                                                    • isTcpKeepAlive(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether TCP keep alive is enabled

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isTcpNoDelay

                                                    +
                                                      +
                                                    • isTcpNoDelay(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether TCP no delay is enabled

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isTcpQuickAck

                                                    +
                                                      +
                                                    • isTcpQuickAck(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isUseAlpn

                                                    +
                                                      +
                                                    • isUseAlpn(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the ALPN usage.

                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    isUsePooledBuffers

                                                    +
                                                      +
                                                    • isUsePooledBuffers(): boolean
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether Netty pooled buffers are enabled

                                                      +
                                                      +
                                                      +
                                                      deprecated
                                                      +

                                                      this has no effect, just don't use it

                                                      +
                                                      +
                                                      +
                                                      +

                                                      Returns boolean

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setEnabledSecureTransportProtocols

                                                    +
                                                      +
                                                    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): TCPSSLOptions
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Sets the list of enabled SSL/TLS protocols.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        enabledSecureTransportProtocols: string
                                                        +
                                                        +

                                                        the SSL/TLS protocols to enable

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setIdleTimeout

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the idle timeout, default time unit is seconds. Zero means don't timeout. + This determines if a connection will timeout and be closed if no data is received within the timeout.

                                                      +
                                                      +

                                                      If you want change default time unit, use {@link #setIdleTimeoutUnit(TimeUnit)}

                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        idleTimeout: number
                                                        +
                                                        +

                                                        the timeout, in seconds

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setIdleTimeoutUnit

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the idle timeout unit. If not specified, default is seconds.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        idleTimeoutUnit: any
                                                        +
                                                        +

                                                        specify time unit.

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setJdkSslEngineOptions

                                                    + + +
                                                    +
                                                    + +

                                                    setKeyStoreOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the key/cert options in jks format, aka Java keystore.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setLogActivity

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        logActivity: boolean
                                                        +
                                                        +

                                                        true for logging the network activity

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setOpenSslEngineOptions

                                                    + + +
                                                    +
                                                    + +

                                                    setPemKeyCertOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the key/cert store options in pem format.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setPemTrustOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the trust options in pem format

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setPfxKeyCertOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the key/cert options in pfx format.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setPfxTrustOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the trust options in pfx format

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setReceiveBufferSize

                                                    +
                                                      +
                                                    • setReceiveBufferSize(receiveBufferSize: number): TCPSSLOptions
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the TCP receive buffer size

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        receiveBufferSize: number
                                                        +
                                                        +

                                                        the buffers size, in bytes

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setReuseAddress

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the value of reuse address

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        reuseAddress: boolean
                                                        +
                                                        +

                                                        the value of reuse address

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setReusePort

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the value of reuse port. +

                                                      + This is only supported by native transports.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        reusePort: boolean
                                                        +
                                                        +

                                                        the value of reuse port

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setSendBufferSize

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the TCP send buffer size

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        sendBufferSize: number
                                                        +
                                                        +

                                                        the buffers size, in bytes

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setSoLinger

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether SO_linger keep alive is enabled

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        soLinger: number
                                                        +
                                                        +

                                                        true if SO_linger is enabled

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setSsl

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether SSL/TLS is enabled

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        ssl: boolean
                                                        +
                                                        +

                                                        true if enabled

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTcpCork

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Enable the {@code TCP_CORK} option - only with linux native transport.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        tcpCork: boolean
                                                        +
                                                        +

                                                        the cork value

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTcpFastOpen

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        tcpFastOpen: boolean
                                                        +
                                                        +

                                                        the fast open value

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTcpKeepAlive

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether TCP keep alive is enabled

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        tcpKeepAlive: boolean
                                                        +
                                                        +

                                                        true if TCP keep alive is enabled

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTcpNoDelay

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether TCP no delay is enabled

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        tcpNoDelay: boolean
                                                        +
                                                        +

                                                        true if TCP no delay is enabled (Nagle disabled)

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTcpQuickAck

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Enable the {@code TCP_QUICKACK} option - only with linux native transport.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        tcpQuickAck: boolean
                                                        +
                                                        +

                                                        the quick ack value

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTrafficClass

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the value of traffic class

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        trafficClass: number
                                                        +
                                                        +

                                                        the value of traffic class

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setTrustStoreOptions

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the trust options in jks format, aka Java truststore

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      + +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setUseAlpn

                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set the ALPN usage.

                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        useAlpn: boolean
                                                        +
                                                        +

                                                        true when Application-Layer Protocol Negotiation should be used

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    + +

                                                    setUsePooledBuffers

                                                    +
                                                      +
                                                    • setUsePooledBuffers(usePooledBuffers: boolean): TCPSSLOptions
                                                      • +
                                                    +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      Set whether Netty pooled buffers are enabled

                                                      +
                                                      +
                                                      +
                                                      deprecated
                                                      +

                                                      this has no effect, just don't use it

                                                      +
                                                      +
                                                      +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • +
                                                        usePooledBuffers: boolean
                                                        +
                                                        +

                                                        true if pooled buffers enabled

                                                        +
                                                        +
                                                        • +
                                                      +

                                                      Returns TCPSSLOptions

                                                      +

                                                      a reference to this, so the API can be used fluently

                                                      +
                                                      • +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Legend

                                                    +
                                                    +
                                                      +
                                                    • Module
                                                      • +
                                                    • Object literal
                                                      • +
                                                    • Variable
                                                      • +
                                                    • Function
                                                      • +
                                                    • Function with type parameter
                                                      • +
                                                    • Index signature
                                                      • +
                                                    • Type alias
                                                      • +
                                                    +
                                                      +
                                                    • Enumeration
                                                      • +
                                                    • Enumeration member
                                                      • +
                                                    • Property
                                                      • +
                                                    • Method
                                                      • +
                                                    +
                                                      +
                                                    • Interface
                                                      • +
                                                    • Interface with type parameter
                                                      • +
                                                    • Constructor
                                                      • +
                                                    • Property
                                                      • +
                                                    • Method
                                                      • +
                                                    • Index signature
                                                      • +
                                                    +
                                                      +
                                                    • Class
                                                      • +
                                                    • Class with type parameter
                                                      • +
                                                    • Constructor
                                                      • +
                                                    • Property
                                                      • +
                                                    • Method
                                                      • +
                                                    • Accessor
                                                      • +
                                                    • Index signature
                                                      • +
                                                    +
                                                      +
                                                    • Inherited constructor
                                                      • +
                                                    • Inherited property
                                                      • +
                                                    • Inherited method
                                                      • +
                                                    • Inherited accessor
                                                      • +
                                                    +
                                                      +
                                                    • Protected property
                                                      • +
                                                    • Protected method
                                                      • +
                                                    • Protected accessor
                                                      • +
                                                    +
                                                      +
                                                    • Private property
                                                      • +
                                                    • Private method
                                                      • +
                                                    • Private accessor
                                                      • +
                                                    +
                                                      +
                                                    • Static property
                                                      • +
                                                    • Static method
                                                      • +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Generated using TypeDoc

                                                    +
                                                    +
                                                    + + + + \ No newline at end of file diff --git a/docs/@vertx/core/classes/timeoutstream.html b/docs/@vertx/core/classes/timeoutstream.html index 9e79a8a76..2463c1397 100644 --- a/docs/@vertx/core/classes/timeoutstream.html +++ b/docs/@vertx/core/classes/timeoutstream.html @@ -72,6 +72,12 @@

                                                    Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -82,6 +88,7 @@

    Methods

  • cancel
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • handler
  • pause
  • resume
    • @@ -102,12 +109,12 @@

    cancel

  • -

    Cancels the timeout. Note this has the same effect as calling {@link #handler(Handler)} with a null +

    Cancels the timeout. Note this has the same effect as calling {@link #handler(Handler)} with a null argument.

    @@ -125,7 +132,7 @@

    endHandler

  • Parameters

    @@ -135,17 +142,19 @@
    endHandler: function
      • -
      • (result: void): void | null | undefined
        • +
      • (res: void): void | Handler<void> | null | undefined

      • Parameters

        • -
          result: void
          +
          res: void

        Returns void + | + Handler<void> | null | @@ -171,7 +180,7 @@

        exceptionHandler

      • Parameters

        @@ -181,17 +190,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -207,6 +218,30 @@

            Returns + +

            fetch

            + +
              +
            • + +

              Parameters

              +
                +
              • +
                amount: number
                +
                • +
              +

              Returns TimeoutStream

              +
              • +
            +

    • handler

    @@ -217,7 +252,7 @@

    handler

  • Parameters

    @@ -227,17 +262,19 @@
    handler: function
      • -
      • (result: number): void | null | undefined
        • +
      • (res: number): void | Handler<number> | null | undefined

      • Parameters

        • -
          result: number
          +
          res: number

        Returns void + | + Handler<number> | null | @@ -262,8 +299,9 @@

        pause

        • Returns TimeoutStream

          @@ -279,8 +317,9 @@

          resume

          • Returns TimeoutStream

            @@ -313,6 +352,9 @@

            Returns exceptionHandler

            • +
          • + fetch +
          • handler
            • diff --git a/docs/@vertx/core/classes/vertx.html b/docs/@vertx/core/classes/vertx.html index 2ddc84c75..21a1932b7 100644 --- a/docs/@vertx/core/classes/vertx.html +++ b/docs/@vertx/core/classes/vertx.html @@ -72,6 +72,12 @@

            Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -92,7 +98,7 @@

    Methods

  • deploymentIDs
  • eventBus
  • exceptionHandler
    • -
  • executeBlocking
    • +
  • executeBlocking
  • fileSystem
  • getOrCreateContext
  • isClustered
    • @@ -125,12 +131,12 @@

    cancelTimer

  • -

    Cancels the timer with the specified {@code id}.

    +

    Cancels the timer with the specified {@code id}.

    Parameters

    @@ -158,12 +164,12 @@

    close

  • -

    Stop the the Vertx instance and release any resources held by it. +

    Stop the the Vertx instance and release any resources held by it.

    The instance cannot be used after it has been closed.

    @@ -175,12 +181,12 @@

    Returns void
    -

    Like {@link #close} but the completionHandler will be called when the close is complete

    +

    Like {@link #close} but the completionHandler will be called when the close is complete

    Parameters

    @@ -193,17 +199,20 @@
    completionHandler: function
    @@ -634,12 +675,12 @@

    deployVerticle

  • -

    Deploy a verticle instance given a name. +

    Deploy a verticle instance given a name.

    Given the name, Vert.x selects a {@link VerticleFactory} instance to use to instantiate the verticle.

    @@ -660,12 +701,12 @@

    Returns void
    -

    Like {@link #deployVerticle(String)} but the completionHandler will be notified when the deployment is complete. +

    Like {@link #deployVerticle(String)} but the completionHandler will be notified when the deployment is complete.

    If the deployment is successful the result will contain a String representing the unique deployment ID of the deployment. @@ -689,17 +730,20 @@

    completionHandler: function
      • @@ -711,12 +755,12 @@

      Returns void
      -

      Like {@link #deployVerticle(Verticle)} but {@link io.vertx.core.DeploymentOptions} are provided to configure the +

      Like {@link #deployVerticle(Verticle)} but {@link io.vertx.core.DeploymentOptions} are provided to configure the deployment.

      @@ -740,12 +784,12 @@

      Returns void
      -

      Like {@link #deployVerticle(String, Handler)} but {@link io.vertx.core.DeploymentOptions} are provided to configure the +

      Like {@link #deployVerticle(String, Handler)} but {@link io.vertx.core.DeploymentOptions} are provided to configure the deployment.

      @@ -771,17 +815,20 @@
      completionHandler: function
        • @@ -802,12 +849,12 @@

        deploymentIDs

      • -

        Return a Set of deployment IDs for the currently deployed deploymentIDs.

        +

        Return a Set of deployment IDs for the currently deployed deploymentIDs.

        Returns string[]

        @@ -825,12 +872,12 @@

        eventBus

      • -

        Get the event bus object. There is a single instance of EventBus per Vertx instance.

        +

        Get the event bus object. There is a single instance of EventBus per Vertx instance.

        Returns EventBus

        @@ -848,12 +895,12 @@

        exceptionHandler

      • -

        Set a default exception handler for Context, set on {@link Context#exceptionHandler(Handler)} at creation.

        +

        Set a default exception handler for Context, set on {@link Context#exceptionHandler(Handler)} at creation.

        Parameters

        @@ -866,17 +913,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -893,23 +942,23 @@

            Returns +

            executeBlocking

            -
              -
            • executeBlocking(blockingCodeHandler: function, ordered: boolean, resultHandler: function): void
              • -
            • executeBlocking(blockingCodeHandler: function, resultHandler: function): void
              • +
                +
              • executeBlocking<T>(blockingCodeHandler: function, ordered: boolean, resultHandler: function): void
                • +
              • executeBlocking<T>(blockingCodeHandler: function, resultHandler: function): void
              • -

                Safely execute some blocking code. +

                Safely execute some blocking code.

                Executes the blocking code in the handler {@code blockingCodeHandler} using a thread from the worker pool.

                @@ -924,6 +973,15 @@

                executeBlocking

                scheduled in the {@code blockingCodeHandler} will be executed on the this context and not on the worker thread.

                +

                Type parameters

                +
                  +
                • +

                  T

                  +
                  +

                  the type of the result

                  +
                  +
                  • +

                Parameters

                • @@ -934,17 +992,20 @@
                  blockingCodeHandler: function
                    • @@ -966,17 +1027,20 @@
                    resultHandler: function
                      • @@ -988,14 +1052,20 @@

                      Returns void
                      -

                      Like {@link #executeBlocking(Handler, boolean, Handler)} called with ordered = true.

                      +

                      Like {@link #executeBlocking(Handler, boolean, Handler)} called with ordered = true.

                      +

                      Type parameters

                      +
                        +
                      • +

                        T

                        +
                        • +

                      Parameters

                      • @@ -1003,17 +1073,20 @@
                        blockingCodeHandler: function
                          • @@ -1024,17 +1097,20 @@
                          resultHandler: function
                            • @@ -1055,12 +1131,12 @@

                            fileSystem

                          • -

                            Get the filesystem object. There is a single instance of FileSystem per Vertx instance.

                            +

                            Get the filesystem object. There is a single instance of FileSystem per Vertx instance.

                            Returns FileSystem

                            @@ -1078,12 +1154,12 @@

                            getOrCreateContext

                          • -

                            Gets the current context, or creates one if there isn't one

                            +

                            Gets the current context, or creates one if there isn't one

                            Returns Context

                            @@ -1101,12 +1177,12 @@

                            isClustered

                          • -

                            Is this Vert.x instance clustered?

                            +

                            Is this Vert.x instance clustered?

                            Returns boolean

                            @@ -1123,17 +1199,23 @@

                            isMetricsEnabled

                            • -

                              Whether the metrics are enabled for this measured object

                              +

                              Whether the metrics are enabled for this measured object

                              +
                              +
                              implspec
                              +

                              The default implementation returns {@code false}

                              +
                              +

                              Returns boolean

                              -

                              true if the metrics are enabled

                              +

                              if metrics are enabled

            @@ -1147,13 +1229,13 @@

            isNativeTransportEnabled

          • Returns boolean

            -

            wether the native transport is used

            +

            whether the native transport is used

    • @@ -1167,12 +1249,12 @@

    periodicStream

  • -

    Returns a periodic timer as a read stream. The timer will be fired every {@code delay} milliseconds after +

    Returns a periodic timer as a read stream. The timer will be fired every {@code delay} milliseconds after the {@link ReadStream#handler} has been called.

    @@ -1200,12 +1282,12 @@

    runOnContext

  • -

    Puts the handler on the event queue for the current context so it will be run asynchronously ASAP after all +

    Puts the handler on the event queue for the current context so it will be run asynchronously ASAP after all preceeding events have been handled.

    @@ -1219,17 +1301,20 @@
    action: function
    • -

    Properties

    -
    - -

    addressResolverOptions

    -
    addressResolverOptions: AddressResolverOptions
    - -
    -
    -

    Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...

    -
    -
    -
    param
    -

    the address resolver options

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    blockedThreadCheckInterval

    -
    blockedThreadCheckInterval: number
    - -
    -
    -

    Sets the value of blocked thread check period, in ms.

    -
    -
    -
    param
    -

    the value of blocked thread check period, in ms.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAddressResolverOptions

    + +
      +
    • + +
      +
      +

      Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...

      +
      +
      +

      Returns AddressResolverOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clusterHost

    -
    clusterHost: string
    - -
    -
    -

    Set the hostname to be used for clustering.

    -
    -
    -
    param
    -

    the host name to use

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getBlockedThreadCheckInterval

    +
      +
    • getBlockedThreadCheckInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the value of blocked thread check period, in {@link VertxOptions#setBlockedThreadCheckIntervalUnit blockedThreadCheckIntervalUnit}. +

      + The default value of {@link VertxOptions#setBlockedThreadCheckIntervalUnit blockedThreadCheckIntervalUnit} is {@link TimeUnit#MILLISECONDS}

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clusterPingInterval

    -
    clusterPingInterval: number
    - -
    -
    -

    Set the value of cluster ping interval, in ms.

    -
    -
    -
    param
    -

    The value of cluster ping interval, in ms.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getBlockedThreadCheckIntervalUnit

    +
      +
    • getBlockedThreadCheckIntervalUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code blockedThreadCheckInterval}.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clusterPingReplyInterval

    -
    clusterPingReplyInterval: number
    - -
    -
    -

    Set the value of cluster ping reply interval, in ms.

    -
    -
    -
    param
    -

    The value of cluster ping reply interval, in ms.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClusterHost

    +
      +
    • getClusterHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the hostname to be used for clustering.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clusterPort

    -
    clusterPort: number
    - -
    -
    -

    Set the port to be used for clustering.

    -
    -
    -
    param
    -

    the port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClusterPingInterval

    +
      +
    • getClusterPingInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of cluster ping interval, in ms.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clusterPublicHost

    -
    clusterPublicHost: string
    - -
    -
    -

    Set the public facing hostname to be used for clustering. - Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same - address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying. - If this is the case you can specify a public hostname which is different from the hostname the server listens at. - The default value is null which means use the same as the cluster hostname.

    -
    -
    -
    param
    -

    the public host name to use

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClusterPingReplyInterval

    +
      +
    • getClusterPingReplyInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of cluster ping reply interval, in ms.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clusterPublicPort

    -
    clusterPublicPort: number
    - -
    -
    -

    See {@link #setClusterPublicHost(String)} for an explanation.

    -
    -
    -
    param
    -

    the public port to use

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClusterPort

    +
      +
    • getClusterPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port to be used for clustering.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    clustered

    -
    clustered: boolean
    - -
    -
    -

    Set whether or not the Vert.x instance will be clustered.

    -
    -
    -
    param
    -

    if true, the Vert.x instance will be clustered, otherwise not

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClusterPublicHost

    +
      +
    • getClusterPublicHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the public facing hostname to be used for clustering. + Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same + address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying. + If this is the case you can specify a public hostname which is different from the hostname the server listens at. + The default value is null which means use the same as the cluster hostname.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    eventBusOptions

    -
    eventBusOptions: EventBusOptions
    - -
    -
    -

    Sets the event bus configuration to configure the host, port, ssl...

    -
    -
    -
    param
    -

    the event bus options

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getClusterPublicPort

    +
      +
    • getClusterPublicPort(): number
      • +
    +
      +
    • + +
      +
      +

      See {@link #setClusterPublicHost(String)} for an explanation.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    eventLoopPoolSize

    -
    eventLoopPoolSize: number
    - -
    -
    -

    Set the number of event loop threads to be used by the Vert.x instance.

    -
    -
    -
    param
    -

    the number of threads

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEventBusOptions

    + +
      +
    • + +
      +
      +

      Sets the event bus configuration to configure the host, port, ssl...

      +
      +
      +

      Returns EventBusOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    fileResolverCachingEnabled

    -
    fileResolverCachingEnabled: boolean
    - -
    -
    -

    Set wether the Vert.x file resolver uses caching for classpath resources.

    -
    -
    -
    param
    -

    true when the file resolver caches resources

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEventLoopPoolSize

    +
      +
    • getEventLoopPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the number of event loop threads to be used by the Vert.x instance.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    haEnabled

    -
    haEnabled: boolean
    - -
    -
    -

    Set whether HA will be enabled on the Vert.x instance.

    -
    -
    -
    param
    -

    true if enabled, false if not.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getFileSystemOptions

    + +
      +
    • + +
      +
      +

      Set the file system options

      +
      +
      +

      Returns FileSystemOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    haGroup

    -
    haGroup: string
    - -
    -
    -

    Set the HA group to be used when HA is enabled.

    -
    -
    -
    param
    -

    the HA group to use

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHAGroup

    +
      +
    • getHAGroup(): string
      • +
    +
      +
    • + +
      +
      +

      Set the HA group to be used when HA is enabled.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    internalBlockingPoolSize

    -
    internalBlockingPoolSize: number
    - -
    -
    -

    Set the value of internal blocking pool size

    -
    -
    -
    param
    -

    the maximumn number of threads in the internal blocking pool

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getInternalBlockingPoolSize

    +
      +
    • getInternalBlockingPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the value of internal blocking pool size

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxEventLoopExecuteTime

    -
    maxEventLoopExecuteTime: number
    - -
    -
    -

    Sets the value of max event loop execute time, in ns.

    -
    -
    -
    param
    -

    the value of max event loop execute time, in ns.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxEventLoopExecuteTime

    +
      +
    • getMaxEventLoopExecuteTime(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the value of max event loop execute time, in {@link VertxOptions#setMaxEventLoopExecuteTimeUnit maxEventLoopExecuteTimeUnit}. +

      + The default value of {@link VertxOptions#setMaxEventLoopExecuteTimeUnit maxEventLoopExecuteTimeUnit}is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxWorkerExecuteTime

    -
    maxWorkerExecuteTime: number
    - -
    -
    -

    Sets the value of max worker execute time, in ns.

    -
    -
    -
    param
    -

    the value of max worker execute time, in ns.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxEventLoopExecuteTimeUnit

    +
      +
    • getMaxEventLoopExecuteTimeUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code maxEventLoopExecuteTime}.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    metricsOptions

    -
    metricsOptions: MetricsOptions
    - -
    -
    -

    Set the metrics options

    -
    -
    -
    param
    -

    the options

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxWorkerExecuteTime

    +
      +
    • getMaxWorkerExecuteTime(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the value of max worker execute time, in {@link VertxOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit}. +

      + The default value of {@link VertxOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit} is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    preferNativeTransport

    -
    preferNativeTransport: boolean
    - -
    -
    -

    Set wether to prefer the native transport to the JDK transport.

    -
    -
    -
    param
    -

    to prefer the native transport

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxWorkerExecuteTimeUnit

    +
      +
    • getMaxWorkerExecuteTimeUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code maxWorkerExecuteTime}.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    quorumSize

    -
    quorumSize: number
    - -
    -
    -

    Set the quorum size to be used when HA is enabled.

    -
    -
    -
    param
    -

    the quorum size

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMetricsOptions

    + +
      +
    • + +
      +
      +

      Set the metrics options

      +
      +
      +

      Returns MetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    warningExceptionTime

    -
    warningExceptionTime: number
    - -
    -
    -

    Set the threshold value above this, the blocked warning contains a stack trace.

    -
    -
    -
    param
    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPreferNativeTransport

    +
      +
    • getPreferNativeTransport(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set wether to prefer the native transport to the JDK transport.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    workerPoolSize

    -
    workerPoolSize: number
    - -
    -
    -

    Set the maximum number of worker threads to be used by the Vert.x instance.

    -
    -
    -
    param
    -

    the number of threads

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getQuorumSize

    +
      +
    • getQuorumSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the quorum size to be used when HA is enabled.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWarningExceptionTime

    +
      +
    • getWarningExceptionTime(): number
      • +
    +
      +
    • + +
      +
      +

      Set the threshold value above this, the blocked warning contains a stack trace. in {@link VertxOptions#setWarningExceptionTimeUnit warningExceptionTimeUnit}. + The default value of {@link VertxOptions#setWarningExceptionTimeUnit warningExceptionTimeUnit} is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWarningExceptionTimeUnit

    +
      +
    • getWarningExceptionTimeUnit(): any
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code warningExceptionTime}.

      +
      +
      +

      Returns any

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWorkerPoolSize

    +
      +
    • getWorkerPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set the maximum number of worker threads to be used by the Vert.x instance.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isClustered

    +
      +
    • isClustered(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether or not the Vert.x instance will be clustered.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isFileResolverCachingEnabled

    +
      +
    • isFileResolverCachingEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether the Vert.x file resolver uses caching for classpath resources.

      +
      +

      Deprecated. Use FileSystemOptions instead.

      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isHAEnabled

    +
      +
    • isHAEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether HA will be enabled on the Vert.x instance.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAddressResolverOptions

    + +
      +
    • + +
      +
      +

      Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...

      +
      +
      +

      Parameters

      + +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setBlockedThreadCheckInterval

    +
      +
    • setBlockedThreadCheckInterval(blockedThreadCheckInterval: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the value of blocked thread check period, in {@link VertxOptions#setBlockedThreadCheckIntervalUnit blockedThreadCheckIntervalUnit}. +

      + The default value of {@link VertxOptions#setBlockedThreadCheckIntervalUnit blockedThreadCheckIntervalUnit} is {@link TimeUnit#MILLISECONDS}

      +
      +
      +

      Parameters

      +
        +
      • +
        blockedThreadCheckInterval: number
        +
        +

        the value of blocked thread check period, in {@link VertxOptions#setBlockedThreadCheckIntervalUnit blockedThreadCheckIntervalUnit}.

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setBlockedThreadCheckIntervalUnit

    +
      +
    • setBlockedThreadCheckIntervalUnit(blockedThreadCheckIntervalUnit: any): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code blockedThreadCheckInterval}.

      +
      +
      +

      Parameters

      +
        +
      • +
        blockedThreadCheckIntervalUnit: any
        +
        +

        the time unit of {@code warningExceptionTime}

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClusterHost

    + +
      +
    • + +
      +
      +

      Set the hostname to be used for clustering.

      +
      +
      +

      Parameters

      +
        +
      • +
        clusterHost: string
        +
        +

        the host name to use

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClusterPingInterval

    +
      +
    • setClusterPingInterval(clusterPingInterval: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the value of cluster ping interval, in ms.

      +
      +
      +

      Parameters

      +
        +
      • +
        clusterPingInterval: number
        +
        +

        The value of cluster ping interval, in ms.

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClusterPingReplyInterval

    +
      +
    • setClusterPingReplyInterval(clusterPingReplyInterval: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the value of cluster ping reply interval, in ms.

      +
      +
      +

      Parameters

      +
        +
      • +
        clusterPingReplyInterval: number
        +
        +

        The value of cluster ping reply interval, in ms.

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClusterPort

    + +
      +
    • + +
      +
      +

      Set the port to be used for clustering.

      +
      +
      +

      Parameters

      +
        +
      • +
        clusterPort: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClusterPublicHost

    +
      +
    • setClusterPublicHost(clusterPublicHost: string): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the public facing hostname to be used for clustering. + Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same + address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying. + If this is the case you can specify a public hostname which is different from the hostname the server listens at. + The default value is null which means use the same as the cluster hostname.

      +
      +
      +

      Parameters

      +
        +
      • +
        clusterPublicHost: string
        +
        +

        the public host name to use

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClusterPublicPort

    +
      +
    • setClusterPublicPort(clusterPublicPort: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      See {@link #setClusterPublicHost(String)} for an explanation.

      +
      +
      +

      Parameters

      +
        +
      • +
        clusterPublicPort: number
        +
        +

        the public port to use

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClustered

    + +
      +
    • + +
      +
      +

      Set whether or not the Vert.x instance will be clustered.

      +
      +
      +

      Parameters

      +
        +
      • +
        clustered: boolean
        +
        +

        if true, the Vert.x instance will be clustered, otherwise not

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEventBusOptions

    + +
      +
    • + +
      +
      +

      Sets the event bus configuration to configure the host, port, ssl...

      +
      +
      +

      Parameters

      + +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setEventLoopPoolSize

    +
      +
    • setEventLoopPoolSize(eventLoopPoolSize: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the number of event loop threads to be used by the Vert.x instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        eventLoopPoolSize: number
        +
        +

        the number of threads

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setFileResolverCachingEnabled

    +
      +
    • setFileResolverCachingEnabled(fileResolverCachingEnabled: boolean): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set whether the Vert.x file resolver uses caching for classpath resources.

      +
      +

      Deprecated. Use FileSystemOptions instead.

      +
      +

      Parameters

      +
        +
      • +
        fileResolverCachingEnabled: boolean
        +
        +

        true when the file resolver caches resources

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setFileSystemOptions

    + +
      +
    • + +
      +
      +

      Set the file system options

      +
      +
      +

      Parameters

      + +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHAEnabled

    + +
      +
    • + +
      +
      +

      Set whether HA will be enabled on the Vert.x instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        haEnabled: boolean
        +
        +

        true if enabled, false if not.

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHAGroup

    + +
      +
    • + +
      +
      +

      Set the HA group to be used when HA is enabled.

      +
      +
      +

      Parameters

      +
        +
      • +
        haGroup: string
        +
        +

        the HA group to use

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setInternalBlockingPoolSize

    +
      +
    • setInternalBlockingPoolSize(internalBlockingPoolSize: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the value of internal blocking pool size

      +
      +
      +

      Parameters

      +
        +
      • +
        internalBlockingPoolSize: number
        +
        +

        the maximumn number of threads in the internal blocking pool

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxEventLoopExecuteTime

    +
      +
    • setMaxEventLoopExecuteTime(maxEventLoopExecuteTime: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the value of max event loop execute time, in {@link VertxOptions#setMaxEventLoopExecuteTimeUnit maxEventLoopExecuteTimeUnit}. +

      + The default value of {@link VertxOptions#setMaxEventLoopExecuteTimeUnit maxEventLoopExecuteTimeUnit}is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Parameters

      +
        +
      • +
        maxEventLoopExecuteTime: number
        +
        +

        the value of max event loop execute time, in {@link VertxOptions#setMaxEventLoopExecuteTimeUnit maxEventLoopExecuteTimeUnit}.

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxEventLoopExecuteTimeUnit

    +
      +
    • setMaxEventLoopExecuteTimeUnit(maxEventLoopExecuteTimeUnit: any): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code maxEventLoopExecuteTime}.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxEventLoopExecuteTimeUnit: any
        +
        +

        the time unit of {@code maxEventLoopExecuteTime}

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWorkerExecuteTime

    +
      +
    • setMaxWorkerExecuteTime(maxWorkerExecuteTime: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Sets the value of max worker execute time, in {@link VertxOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit}. +

      + The default value of {@link VertxOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit} is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWorkerExecuteTime: number
        +
        +

        the value of max worker execute time, in {@link VertxOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit}.

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxWorkerExecuteTimeUnit

    +
      +
    • setMaxWorkerExecuteTimeUnit(maxWorkerExecuteTimeUnit: any): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code maxWorkerExecuteTime}.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxWorkerExecuteTimeUnit: any
        +
        +

        the time unit of {@code maxWorkerExecuteTime}

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMetricsOptions

    + +
      +
    • + +
      +
      +

      Set the metrics options

      +
      +
      +

      Parameters

      + +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPreferNativeTransport

    +
      +
    • setPreferNativeTransport(preferNativeTransport: boolean): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set wether to prefer the native transport to the JDK transport.

      +
      +
      +

      Parameters

      +
        +
      • +
        preferNativeTransport: boolean
        +
        +

        to prefer the native transport

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setQuorumSize

    + +
      +
    • + +
      +
      +

      Set the quorum size to be used when HA is enabled.

      +
      +
      +

      Parameters

      +
        +
      • +
        quorumSize: number
        +
        +

        the quorum size

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWarningExceptionTime

    +
      +
    • setWarningExceptionTime(warningExceptionTime: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the threshold value above this, the blocked warning contains a stack trace. in {@link VertxOptions#setWarningExceptionTimeUnit warningExceptionTimeUnit}. + The default value of {@link VertxOptions#setWarningExceptionTimeUnit warningExceptionTimeUnit} is {@link TimeUnit#NANOSECONDS}

      +
      +
      +

      Parameters

      +
        +
      • +
        warningExceptionTime: number
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWarningExceptionTimeUnit

    +
      +
    • setWarningExceptionTimeUnit(warningExceptionTimeUnit: any): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the time unit of {@code warningExceptionTime}.

      +
      +
      +

      Parameters

      +
        +
      • +
        warningExceptionTimeUnit: any
        +
        +

        the time unit of {@code warningExceptionTime}

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWorkerPoolSize

    +
      +
    • setWorkerPoolSize(workerPoolSize: number): VertxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the maximum number of worker threads to be used by the Vert.x instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        workerPoolSize: number
        +
        +

        the number of threads

        +
        +
        • +
      +

      Returns VertxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -634,71 +1698,170 @@

    workerPoolSize

  • VertxOptions
    • diff --git a/docs/@vertx/core/classes/websocket.html b/docs/@vertx/core/classes/websocket.html index a95857118..d6236e336 100644 --- a/docs/@vertx/core/classes/websocket.html +++ b/docs/@vertx/core/classes/websocket.html @@ -72,6 +72,12 @@

    Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -87,6 +93,7 @@

    Methods

  • end
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • frameHandler
  • handler
  • isSsl
    • @@ -124,13 +131,14 @@

    binaryHandlerID

    • -

      When a {@code Websocket} is created it automatically registers an event handler with the event bus - the ID of that +

      When a {@code Websocket} is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

      Given this ID, a different event loop can send a binary frame to that event handler using the event bus and @@ -153,12 +161,12 @@

      binaryMessageHandler

    • -

      Set a binary message handler on the connection. This handler serves a similar purpose to {@link #handler(Handler)} +

      Set a binary message handler on the connection. This handler serves a similar purpose to {@link #handler(Handler)} except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using {@link WebSocketFrame#isFinal()} to find the boundaries).

      @@ -173,17 +181,19 @@
      handler: function

        • Parameters

          Returns void + | + Handler<Buffer> | null | @@ -211,21 +221,25 @@

          close

          • -

            Close the WebSocket.

            +

            Close the WebSocket sending the default close frame. +

            + No more messages can be sent.

            Returns void

          • Parameters

            @@ -238,8 +252,9 @@

            Returns void

          • Parameters

            @@ -265,7 +280,7 @@

            closeHandler

          • Parameters

            @@ -275,17 +290,19 @@
            handler: function
              • -
              • (result: void): void | null | undefined
                • +
              • (res: void): void | Handler<void> | null | undefined

              • Parameters

                • -
                  result: void
                  +
                  res: void

                Returns void + | + Handler<void> | null | @@ -311,7 +328,7 @@

                drainHandler

              • Parameters

                @@ -321,17 +338,19 @@
                handler: function
                  • -
                  • (result: void): void | null | undefined
                    • +
                  • (res: void): void | Handler<void> | null | undefined

                  • Parameters

                    • -
                      result: void
                      +
                      res: void

                    Returns void + | + Handler<void> | null | @@ -357,13 +376,14 @@

                    end

                    • -

                      Same as {@link #end()} but writes some data to the stream before ending.

                      +

                      Same as {@link #end()} but writes some data to the stream before ending.

                      Parameters

                      @@ -376,13 +396,14 @@

                      Returns void
                    • -

                      Calls {@link #close()}

                      +

                      Calls {@link #close()}

                      Returns void

                      @@ -399,7 +420,7 @@

                      endHandler

                    • Parameters

                      @@ -409,17 +430,19 @@
                      endHandler: function
                        • -
                        • (result: void): void | null | undefined
                          • +
                        • (res: void): void | Handler<void> | null | undefined

                        • Parameters

                          • -
                            result: void
                            +
                            res: void

                          Returns void + | + Handler<void> | null | @@ -445,7 +468,7 @@

                          exceptionHandler

                        • Parameters

                          @@ -455,17 +478,19 @@
                          handler: function
                            • -
                            • (result: Error): void | null | undefined
                              • +
                            • (res: Error): void | Handler<Error> | null | undefined

                            • Parameters

                              • -
                                result: Error
                                +
                                res: Error

                              Returns void + | + Handler<Error> | null | @@ -481,6 +506,30 @@

                              Returns + +

                              fetch

                              + +
                                +
                              • + +

                                Parameters

                                +
                                  +
                                • +
                                  amount: number
                                  +
                                  • +
                                +

                                Returns WebSocket

                                +
                                • +
                              +

    frameHandler

    @@ -491,7 +540,7 @@

    frameHandler

  • Parameters

    @@ -501,17 +550,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<WebSocketFrame> | null | @@ -537,7 +588,7 @@

        handler

      • Parameters

        @@ -547,17 +598,19 @@
        handler: function

          • Parameters

            Returns void + | + Handler<Buffer> | null | @@ -582,8 +635,9 @@

            isSsl

            • @@ -602,8 +656,9 @@

              localAddress

              • @@ -622,8 +677,9 @@

                pause

                • Returns WebSocket

                  @@ -640,12 +696,12 @@

                  pongHandler

                • -

                  Set a pong message handler on the connection. This handler will be invoked every time a pong message is received +

                  Set a pong message handler on the connection. This handler will be invoked every time a pong message is received on the server, and can be used by both clients and servers since the RFC 6455 Sections 5.5.2 and 5.5.3 do not specify whether the client or server sends a ping.

                  @@ -666,17 +722,19 @@

                  handler: function

                    • Parameters

                      Returns void + | + Handler<Buffer> | null | @@ -702,8 +760,9 @@

                      remoteAddress

                      • @@ -722,8 +781,9 @@

                        resume

                        • Returns WebSocket

                          @@ -739,8 +799,9 @@

                          setWriteQueueMaxSize

                          • Parameters

                            @@ -762,13 +823,14 @@

                            subProtocol

                            • -

                              Returns the websocket sub protocol selected by the websocket handshake. +

                              Returns the websocket sub protocol selected by the websocket handshake.

                              On the server, the value will be {@code null} when the handler receives the websocket callback as the handshake will not be completed yet.

                              @@ -787,13 +849,14 @@

                              textHandlerID

                              • -

                                When a {@code Websocket} is created it automatically registers an event handler with the eventbus, the ID of that +

                                When a {@code Websocket} is created it automatically registers an event handler with the eventbus, the ID of that handler is given by {@code textHandlerID}.

                                Given this ID, a different event loop can send a text frame to that event handler using the event bus and @@ -815,12 +878,12 @@

                                textMessageHandler

                              • -

                                Set a text message handler on the connection. This handler will be called similar to the +

                                Set a text message handler on the connection. This handler will be called similar to the {@link #binaryMessageHandler(Handler)}, but the buffer will be converted to a String first

                                @@ -834,17 +897,19 @@
                                handler: function
                                  • -
                                  • (result: string): void | null | undefined
                                    • +
                                  • (res: string): void | Handler<string> | null | undefined

                                  • Parameters

                                    • -
                                      result: string
                                      +
                                      res: string

                                    Returns void + | + Handler<string> | null | @@ -870,8 +935,9 @@

                                    write

                                    • Parameters

                                      @@ -893,8 +959,9 @@

                                      writeBinaryMessage

                                      • Parameters

                                        @@ -916,8 +983,9 @@

                                        writeFinalBinaryFrame

                                        • Parameters

                                          @@ -939,8 +1007,9 @@

                                          writeFinalTextFrame

                                          • Parameters

                                            @@ -962,8 +1031,9 @@

                                            writeFrame

                                            • Parameters

                                              @@ -985,13 +1055,14 @@

                                              writePing

                                              • -

                                                Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets). +

                                                Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

                                                This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2. @@ -1023,13 +1094,14 @@

                                                writePong

                                                • -

                                                  Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets). +

                                                  Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

                                                  This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2. @@ -1062,13 +1134,14 @@

                                                  writeQueueFull

                                                  • -

                                                    This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                                    +

                                                    This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                                    #setWriteQueueMaxSize}

                                                    @@ -1086,8 +1159,9 @@

                                                    writeTextMessage

                                                    • Parameters

                                                      @@ -1141,6 +1215,9 @@

                                                      Returns exceptionHandler

                                                      • +
                                                    • + fetch +
                                                    • frameHandler
                                                      • diff --git a/docs/@vertx/core/classes/websocketframe.html b/docs/@vertx/core/classes/websocketframe.html index 98c565945..39cbd47fc 100644 --- a/docs/@vertx/core/classes/websocketframe.html +++ b/docs/@vertx/core/classes/websocketframe.html @@ -110,7 +110,7 @@

                                                      binaryData

                                                    • @@ -130,7 +130,7 @@

                                                      closeReason

                                                    • @@ -150,7 +150,7 @@

                                                      closeStatusCode

                                                    • @@ -170,7 +170,7 @@

                                                      isBinary

                                                    • @@ -190,7 +190,7 @@

                                                      isClose

                                                    • @@ -210,7 +210,7 @@

                                                      isContinuation

                                                    • @@ -230,7 +230,7 @@

                                                      isFinal

                                                    • @@ -250,7 +250,7 @@

                                                      isText

                                                    • @@ -270,7 +270,7 @@

                                                      textData

                                                    • @@ -291,12 +291,12 @@

                                                      Static binaryFrame

                                                    • -

                                                      Create a binary WebSocket frame.

                                                      +

                                                      Create a binary WebSocket frame.

                                                      Parameters

                                                      @@ -329,12 +329,12 @@

                                                      Static continuationFrame
                                                      -

                                                      Create a continuation frame

                                                      +

                                                      Create a continuation frame

                                                      Parameters

                                                      @@ -367,12 +367,12 @@

                                                      Static pingFrame

                                                    • -

                                                      Create a ping WebSocket frame. Will be a final frame. There is no option for non final ping frames.

                                                      +

                                                      Create a ping WebSocket frame. Will be a final frame. There is no option for non final ping frames.

                                                      Parameters

                                                      @@ -399,12 +399,12 @@

                                                      Static pongFrame

                                                    • -

                                                      Create a pong WebSocket frame. Will be a final frame. There is no option for non final pong frames.

                                                      +

                                                      Create a pong WebSocket frame. Will be a final frame. There is no option for non final pong frames.

                                                      Parameters

                                                      @@ -431,12 +431,12 @@

                                                      Static textFrame

                                                    • -

                                                      Create a text WebSocket frame.

                                                      +

                                                      Create a text WebSocket frame.

                                                      Parameters

                                                      diff --git a/docs/@vertx/core/classes/workerexecutor.html b/docs/@vertx/core/classes/workerexecutor.html index 13a2ad28b..7e78255dc 100644 --- a/docs/@vertx/core/classes/workerexecutor.html +++ b/docs/@vertx/core/classes/workerexecutor.html @@ -72,6 +72,12 @@

                                                      Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -80,7 +86,7 @@

    Index

    Methods

    @@ -99,35 +105,35 @@

    close

  • -

    Close the executor.

    +

    Close the executor.

    Returns void

    • -
    +

    executeBlocking

    -
      -
    • executeBlocking(blockingCodeHandler: function, ordered: boolean, resultHandler: function): void
      • -
    • executeBlocking(blockingCodeHandler: function, resultHandler: function): void
      • +
        +
      • executeBlocking<T>(blockingCodeHandler: function, ordered: boolean, resultHandler: function): void
        • +
      • executeBlocking<T>(blockingCodeHandler: function, resultHandler: function): void
      • -

        Safely execute some blocking code. +

        Safely execute some blocking code.

        Executes the blocking code in the handler {@code blockingCodeHandler} using a thread from the worker pool.

        @@ -142,6 +148,15 @@

        executeBlocking

        scheduled in the {@code blockingCodeHandler} will be executed on the this context and not on the worker thread.

        +

        Type parameters

        +
          +
        • +

          T

          +
          +

          the type of the result

          +
          +
          • +

        Parameters

        • @@ -152,17 +167,20 @@
          blockingCodeHandler: function
            • @@ -184,17 +202,20 @@
            resultHandler: function
              • @@ -206,14 +227,20 @@

              Returns void
              -

              Like {@link #executeBlocking(Handler, boolean, Handler)} called with ordered = true.

              +

              Like {@link #executeBlocking(Handler, boolean, Handler)} called with ordered = true.

              +

              Type parameters

              +
                +
              • +

                T

                +
                • +

              Parameters

              • @@ -221,17 +248,20 @@
                blockingCodeHandler: function
                  • @@ -242,17 +272,20 @@
                  resultHandler: function
                    • @@ -272,17 +305,23 @@

                    isMetricsEnabled

                    • -

                      Whether the metrics are enabled for this measured object

                      +

                      Whether the metrics are enabled for this measured object

                      +
                      +
                      implspec
                      +

                      The default implementation returns {@code false}

                      +
                      +

                      Returns boolean

                      -

                      true if the metrics are enabled

                      +

                      if metrics are enabled

    @@ -306,7 +345,7 @@

    Returns boolean close -
  • +
  • executeBlocking
  • diff --git a/docs/@vertx/core/enums/clientauth.html b/docs/@vertx/core/enums/clientauth.html index d4c922018..d2ab06299 100644 --- a/docs/@vertx/core/enums/clientauth.html +++ b/docs/@vertx/core/enums/clientauth.html @@ -87,7 +87,7 @@

    NONE

    NONE:

    • @@ -97,7 +97,7 @@

    REQUEST

    REQUEST:
    @@ -107,7 +107,7 @@

    REQUIRED

    REQUIRED:
    diff --git a/docs/@vertx/core/enums/dnsresponsecode.html b/docs/@vertx/core/enums/dnsresponsecode.html index 1404daa47..48448ccca 100644 --- a/docs/@vertx/core/enums/dnsresponsecode.html +++ b/docs/@vertx/core/enums/dnsresponsecode.html @@ -99,7 +99,7 @@

    BADKEY

    BADKEY:
    @@ -109,7 +109,7 @@

    BADSIG

    BADSIG:
    @@ -119,7 +119,7 @@

    BADTIME

    BADTIME:
    @@ -129,7 +129,7 @@

    BADVERS

    BADVERS:
    @@ -139,7 +139,7 @@

    FORMERROR

    FORMERROR:
    @@ -149,7 +149,7 @@

    NOERROR

    NOERROR:
    @@ -159,7 +159,7 @@

    NOTAUTH

    NOTAUTH:
    @@ -169,7 +169,7 @@

    NOTIMPL

    NOTIMPL:
    @@ -179,7 +179,7 @@

    NOTZONE

    NOTZONE:
    @@ -189,7 +189,7 @@

    NXDOMAIN

    NXDOMAIN:
    @@ -199,7 +199,7 @@

    NXRRSET

    NXRRSET:
    @@ -209,7 +209,7 @@

    REFUSED

    REFUSED:
    @@ -219,7 +219,7 @@

    SERVFAIL

    SERVFAIL:
    @@ -229,7 +229,7 @@

    YXDOMAIN

    YXDOMAIN:
    @@ -239,7 +239,7 @@

    YXRRSET

    YXRRSET:
    diff --git a/docs/@vertx/core/enums/httpmethod.html b/docs/@vertx/core/enums/httpmethod.html index fda18612e..334bb6ffb 100644 --- a/docs/@vertx/core/enums/httpmethod.html +++ b/docs/@vertx/core/enums/httpmethod.html @@ -94,7 +94,7 @@

    CONNECT

    CONNECT:
    @@ -104,7 +104,7 @@

    DELETE

    DELETE:
    @@ -114,7 +114,7 @@

    GET

    GET:
    @@ -124,7 +124,7 @@

    HEAD

    HEAD:
    @@ -134,7 +134,7 @@

    OPTIONS

    OPTIONS:
    @@ -144,7 +144,7 @@

    OTHER

    OTHER:
    @@ -154,7 +154,7 @@

    PATCH

    PATCH:
    @@ -164,7 +164,7 @@

    POST

    POST:
    @@ -174,7 +174,7 @@

    PUT

    PUT:
    @@ -184,7 +184,7 @@

    TRACE

    TRACE:
    diff --git a/docs/@vertx/core/enums/httpversion.html b/docs/@vertx/core/enums/httpversion.html index 99cb9118f..07f78a001 100644 --- a/docs/@vertx/core/enums/httpversion.html +++ b/docs/@vertx/core/enums/httpversion.html @@ -87,7 +87,7 @@

    HTTP_1_0

    HTTP_1_0:
    @@ -97,7 +97,7 @@

    HTTP_1_1

    HTTP_1_1:
    @@ -107,7 +107,7 @@

    HTTP_2

    HTTP_2:
    diff --git a/docs/@vertx/core/enums/jsoneventtype.html b/docs/@vertx/core/enums/jsoneventtype.html index 2ae7d8dd0..0549bd896 100644 --- a/docs/@vertx/core/enums/jsoneventtype.html +++ b/docs/@vertx/core/enums/jsoneventtype.html @@ -89,7 +89,7 @@

    END_ARRAY

    END_ARRAY:
    @@ -99,7 +99,7 @@

    END_OBJECT

    END_OBJECT:
    @@ -109,7 +109,7 @@

    START_ARRAY

    START_ARRAY:
    @@ -119,7 +119,7 @@

    START_OBJECT

    START_OBJECT:
    @@ -129,7 +129,7 @@

    VALUE

    VALUE:
    diff --git a/docs/@vertx/core/enums/proxytype.html b/docs/@vertx/core/enums/proxytype.html index 10a65213f..4f51cfb75 100644 --- a/docs/@vertx/core/enums/proxytype.html +++ b/docs/@vertx/core/enums/proxytype.html @@ -87,7 +87,7 @@

    HTTP

    HTTP:
    @@ -97,7 +97,7 @@

    SOCKS4

    SOCKS4:
    @@ -107,7 +107,7 @@

    SOCKS5

    SOCKS5:
    diff --git a/docs/@vertx/core/enums/replyfailure.html b/docs/@vertx/core/enums/replyfailure.html index 48df060d2..a22d47ee1 100644 --- a/docs/@vertx/core/enums/replyfailure.html +++ b/docs/@vertx/core/enums/replyfailure.html @@ -87,7 +87,7 @@

    NO_HANDLERS

    NO_HANDLERS:
    @@ -97,7 +97,7 @@

    RECIPIENT_FAILURE

    RECIPIENT_FAILURE:
    @@ -107,7 +107,7 @@

    TIMEOUT

    TIMEOUT:
    diff --git a/docs/@vertx/core/enums/websocketversion.html b/docs/@vertx/core/enums/websocketversion.html index 1540599e0..86884c7bb 100644 --- a/docs/@vertx/core/enums/websocketversion.html +++ b/docs/@vertx/core/enums/websocketversion.html @@ -88,7 +88,7 @@

    V00

    V00:
    @@ -98,7 +98,7 @@

    V07

    V07:
    @@ -108,7 +108,7 @@

    V08

    V08:
    @@ -118,7 +118,7 @@

    V13

    V13:
    diff --git a/docs/@vertx/core/globals.html b/docs/@vertx/core/globals.html index 6c593d71d..fc2d0cb96 100644 --- a/docs/@vertx/core/globals.html +++ b/docs/@vertx/core/globals.html @@ -90,9 +90,10 @@

    Classes

  • AddressResolverOptions
  • Argument
  • AsyncFile
    • -
  • AsyncMap
    • +
  • AsyncMap
  • Buffer
  • CLI
    • +
  • ClientOptionsBase
  • CommandLine
  • CompositeFuture
  • Context
    • @@ -101,6 +102,7 @@

    Classes

  • DatagramPacket
  • DatagramSocket
  • DatagramSocketOptions
    • +
  • DeliveryContext
  • DeliveryOptions
  • DeploymentOptions
  • DnsClient
    • @@ -109,8 +111,9 @@

    Classes

  • EventBusOptions
  • FileProps
  • FileSystem
    • +
  • FileSystemOptions
  • FileSystemProps
    • -
  • Future
    • +
  • Future
  • GoAway
  • Http2Settings
  • HttpClient
    • @@ -128,11 +131,11 @@

    Classes

  • JksOptions
  • JsonEvent
  • JsonParser
    • -
  • LocalMap
    • +
  • LocalMap
  • Lock
    • -
  • Message
    • -
  • MessageConsumer
    • -
  • MessageProducer
    • +
  • Message
    • +
  • MessageConsumer
    • +
  • MessageProducer
  • MetricsOptions
  • MultiMap
  • MxRecord
    • @@ -141,6 +144,7 @@

    Classes

  • NetServer
  • NetServerOptions
  • NetSocket
    • +
  • NetworkOptions
  • OpenOptions
  • OpenSSLEngineOptions
  • Option
    • @@ -152,11 +156,12 @@

    Classes

  • RecordParser
  • RequestOptions
  • SelfSignedCertificate
    • -
  • SendContext
  • ServerWebSocket
  • SharedData
  • SocketAddress
  • SrvRecord
    • +
  • StreamPriority
    • +
  • TCPSSLOptions
  • TimeoutStream
  • Vertx
  • VertxOptions
    • @@ -169,574 +174,17 @@

    Classes

    Interfaces

    -
    -
    -

    Variables

    - -
    -
    -

    Functions

    -
    -
    -

    Variables

    -
    - -

    Const Java

    -
    Java: object
    - -
    -

    Type declaration

    -
      -
    • -
      from: function
      -
        -
      • from(value: any): any
        • -
      -
        -
      • - -
        -
        -

        The from function creates a shallow copy of the Java datastructure (Array, List) as a JavaScript array.

        -
        -

        In many cases, this is not necessary, you can typically use the Java datastructure directly - from JavaScript.

        -
        -

        Parameters

        -
          -
        • -
          value: any
          -
          -
          -
          • -
        -

        Returns any

        -
        • -
      • -
    • -
      isJavaObject: function
      -
        -
      • isJavaObject(obj: any): boolean
        • -
      -
        -
      • - -
        -
        -

        The isJavaObject method returns whether obj is an object of the Java language.

        -
        -

        It returns false for native JavaScript objects, as well as for objects of other polyglot languages.

        -
        -

        Parameters

        -
          -
        • -
          obj: any
          -
          -
          -
          • -
        -

        Returns boolean

        -
        • -
      • -
    • -
      isType: function
      -
        -
      • isType(obj: any): boolean
        • -
      -
        -
      • - -
        -
        -

        The isType method returns whether obj is an object of the Java language, - representing a Java Class instance. It returns false for all other arguments.

        -
        -
        -

        Parameters

        -
          -
        • -
          obj: any
          -
          -
          -
          • -
        -

        Returns boolean

        -
        • -
      • -
    • -
      to: function
      -
        -
      • to(jsValue: any, javaType: any): any
        • -
      -
        -
      • - -
        -
        -

        The to function converts the argument to a Java dataype.

        -
        -

        When no toType is provided, Object[] is assumed.

        -
        -

        Parameters

        -
          -
        • -
          jsValue: any
          -
          • -
        • -
          javaType: any
          -
          -
          -
          • -
        -

        Returns any

        -
        • -
      • -
    • -
      type: function
      -
        -
      • type(className: string): any
        • -
      -
        -
      • - -
        -
        -

        The type function loads the specified Java class and provides it as an object.

        -
        -

        Fields of this object can be read directly from it, and new instances can be created with the - JavaScript new keyword.

        -
        -

        Parameters

        -
          -
        • -
          className: string
          -
          -
          -
          • -
        -

        Returns any

        -
        • -
      • -
    • -
      typeName: function
      -
        -
      • typeName(obj: any): string | undefined
        • -
      -
        -
      • - -
        -
        -

        The typeName method returns the Java Class name of obj. obj is expected to represent - a Java Class instance, i.e., isType(obj) should return true; otherwise, undefined is returned.

        -
        -
        -

        Parameters

        -
          -
        • -
          obj: any
          -
          -
          -
          • -
        -

        Returns string - | - undefined -

        -
        • -
      • -
    -
    -
    -
    - -

    Const process

    -
    process: object
    - -
    -

    Type declaration

    -
      -
    • -
      engine: String
      -
      • -
    • -
      env: object
      -
        -
      • -
        [key: string]: string
        -
        • -
      -
      • -
    • -
      exit: function
      -
        -
      • -
          -
        • (exitCode: Number): void
          • -
        -
          -
        • -

          Parameters

          -
            -
          • -
            exitCode: Number
            -
            • -
          -

          Returns void

          -
          • -
        -
        • -
      -
      • -
    • -
      nextTick: function
      -
        -
      • -
          -
        • (callback: function): void
          • -
        -
          -
        • -

          Parameters

          -
            -
          • -
            callback: function
            -
              -
            • -
                -
              • (...args: any[]): void
                • -
              -
                -
              • -

                Parameters

                -
                  -
                • -
                  Rest ...args: any[]
                  -
                  • -
                -

                Returns void

                -
                • -
              -
              • -
            -
            • -
          -

          Returns void

          -
          • -
        -
        • -
      -
      • -
    • -
      pid: String
      -
      • -
    • -
      stderr: any
      -
      • -
    • -
      stdin: any
      -
      • -
    • -
      stdout: any
      -
      • -
    -
    -
    -
    - -

    Const require

    -
    require: object
    - -
    -

    Type declaration

    -
      -
    • -
        -
      • (id: string): any
        • -
      -
        -
      • -

        Parameters

        -
          -
        • -
          id: string
          -
          • -
        -

        Returns any

        -
        • -
      -
      • -
    • -
      cache: any
      -
      • -
    • -
      extensions: any
      -
      • -
    • -
      resolve: function
      -
        -
      • resolve(): string
        • -
      -
      • -
    -
    -
    -
    -
    -

    Functions

    -
    - -

    clearInterval

    -
      -
    • clearInterval(intervalId: Number): any
      • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        intervalId: Number
        -
        • -
      -

      Returns any

      -
      • -
    -
    -
    - -

    clearTimeout

    -
      -
    • clearTimeout(timeoutId: Number): any
      • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        timeoutId: Number
        -
        • -
      -

      Returns any

      -
      • -
    -
    -
    - -

    setImmediate

    -
      -
    • setImmediate(callback: function, ...args: any[]): any
      • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        callback: function
        -
          -
        • -
            -
          • (...args: any[]): void
            • -
          -
            -
          • -

            Parameters

            -
              -
            • -
              Rest ...args: any[]
              -
              • -
            -

            Returns void

            -
            • -
          -
          • -
        -
        • -
      • -
        Rest ...args: any[]
        -
        • -
      -

      Returns any

      -
      • -
    -
    -
    - -

    setInterval

    -
      -
    • setInterval(callback: function, ms: number, ...args: any[]): Number
      • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        callback: function
        -
          -
        • -
            -
          • (...args: any[]): void
            • -
          -
            -
          • -

            Parameters

            -
              -
            • -
              Rest ...args: any[]
              -
              • -
            -

            Returns void

            -
            • -
          -
          • -
        -
        • -
      • -
        ms: number
        -
        • -
      • -
        Rest ...args: any[]
        -
        • -
      -

      Returns Number

      -
      • -
    -
    -
    - -

    setTimeout

    -
      -
    • setTimeout(callback: function, ms: number, ...args: any[]): Number
      • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        callback: function
        -
          -
        • -
            -
          • (...args: any[]): void
            • -
          -
            -
          • -

            Parameters

            -
              -
            • -
              Rest ...args: any[]
              -
              • -
            -

            Returns void

            -
            • -
          -
          • -
        -
        • -
      • -
        ms: number
        -
        • -
      • -
        Rest ...args: any[]
        -
        • -
      -

      Returns Number

      -
      • -
    -
    -
    diff --git a/docs/@vertx/core/index.html b/docs/@vertx/core/index.html index b5e814ec9..a3ba1ee59 100644 --- a/docs/@vertx/core/index.html +++ b/docs/@vertx/core/index.html @@ -143,7 +143,7 @@
  • AsyncFile
    • -
  • +
  • AsyncMap
  • @@ -152,6 +152,9 @@
  • CLI
    • +
  • + ClientOptionsBase +
  • CommandLine
    • @@ -176,6 +179,9 @@
  • DatagramSocketOptions
    • +
  • + DeliveryContext +
  • DeliveryOptions
    • @@ -201,9 +207,12 @@ FileSystem
  • - FileSystemProps + FileSystemOptions
  • + FileSystemProps +
    • +
  • Future
  • @@ -257,19 +266,19 @@
  • JsonParser
    • -
  • +
  • LocalMap
  • Lock
    • -
  • +
  • Message
    • -
  • +
  • MessageConsumer
    • -
  • +
  • MessageProducer
  • @@ -296,6 +305,9 @@
  • NetSocket
    • +
  • + NetworkOptions +
  • OpenOptions
    • @@ -329,9 +341,6 @@
  • SelfSignedCertificate
    • -
  • - SendContext -
  • ServerWebSocket
    • @@ -344,6 +353,12 @@
  • SrvRecord
    • +
  • + StreamPriority +
    • +
  • + TCPSSLOptions +
  • TimeoutStream
    • @@ -365,54 +380,24 @@
  • AsyncResult
    • -
  • - ClientOptionsBase +
  • + Handler
  • Measured
    • -
  • - NetworkOptions -
    • -
  • +
  • ReadStream
  • StreamBase
    • -
  • - TCPSSLOptions -
  • WebSocketBase
    • -
  • +
  • WriteStream
    • -
  • - Java -
    • -
  • - process -
    • -
  • - require -
    • -
  • - clearInterval -
    • -
  • - clearTimeout -
    • -
  • - setImmediate -
    • -
  • - setInterval -
    • -
  • - setTimeout -
    • diff --git a/docs/@vertx/core/interfaces/asyncresult.html b/docs/@vertx/core/interfaces/asyncresult.html index 1134a7d72..2e1a02ed3 100644 --- a/docs/@vertx/core/interfaces/asyncresult.html +++ b/docs/@vertx/core/interfaces/asyncresult.html @@ -108,7 +108,7 @@

    cause

  • Returns Error @@ -128,7 +128,7 @@

    failed

  • Returns boolean

    @@ -145,7 +145,7 @@

    result

  • Returns T @@ -165,7 +165,7 @@

    succeeded

  • Returns boolean

    diff --git a/docs/@vertx/core/interfaces/clientoptionsbase.html b/docs/@vertx/core/interfaces/clientoptionsbase.html deleted file mode 100644 index a90cd9a96..000000000 --- a/docs/@vertx/core/interfaces/clientoptionsbase.html +++ /dev/null @@ -1,1045 +0,0 @@ - - - - - - ClientOptionsBase | @vertx/core - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Interface ClientOptionsBase

    -
    -
    -
    -
    -
    -
    -
    -

    Hierarchy

    -
      -
    • - ClientOptionsBase -
      • -
    -
    -
    -

    Index

    -
    -
    -
    -

    Properties

    - -
    -
    -
    -
    -
    -

    Properties

    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - -
    -
    -

    Set the connect timeout

    -
    -
    -
    param
    -

    connect timeout, in ms

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    crlPaths

    -
    crlPaths: string
    - -
    -
    -

    Add a CRL path

    -
    -
    -
    param
    -

    the path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    -
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - -
    -
    -

    Add a CRL value

    -
    -
    -
    param
    -

    the value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    throws
    -

    NullPointerException

    -
    -
    -
    -
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - -
    -
    -

    Add an enabled cipher suite, appended to the ordered suites.

    -
    -
    -
    param
    -

    the suite

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - -
    -
    -

    Sets the list of enabled SSL/TLS protocols.

    -
    -
    -
    param
    -

    the SSL/TLS protocols to enable

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - -
    -
    -

    Set the idle timeout, in seconds. zero means don't timeout. - This determines if a connection will timeout and be closed if no data is received within the timeout.

    -
    -
    -
    param
    -

    the timeout, in seconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - -
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - -
    -
    -

    Set the key/cert options in jks format, aka Java keystore.

    -
    -
    -
    param
    -

    the key store in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    localAddress

    -
    localAddress: string
    - -
    -
    -

    Set the local interface to bind for network connections. When the local address is null, - it will pick any local address, the default local address is null.

    -
    -
    -
    param
    -

    the local address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    logActivity

    -
    logActivity: boolean
    - -
    -
    -

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    -
    -
    -
    param
    -

    true for logging the network activity

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    metricsName

    -
    metricsName: string
    - -
    -
    -

    Set the metrics name identifying the reported metrics, useful for grouping metrics - with the same name.

    -
    -
    -
    param
    -

    the metrics name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - -
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - -
    -
    -

    Set the key/cert store options in pem format.

    -
    -
    -
    param
    -

    the options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - -
    -
    -

    Set the trust options in pem format

    -
    -
    -
    param
    -

    the trust options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - -
    -
    -

    Set the key/cert options in pfx format.

    -
    -
    -
    param
    -

    the key cert options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - -
    -
    -

    Set the trust options in pfx format

    -
    -
    -
    param
    -

    the trust options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - -
    -
    -

    Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    -
    -
    -
    param
    -

    proxy options object

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - -
    -
    -

    Set the TCP receive buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - -
    -
    -

    Set the value of reuse address

    -
    -
    -
    param
    -

    the value of reuse address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    reusePort

    -
    reusePort: boolean
    - -
    -
    -

    Set the value of reuse port. -

    - This is only supported by native transports.

    -
    -
    -
    param
    -

    the value of reuse port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - -
    -
    -

    Set the TCP send buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    soLinger

    -
    soLinger: number
    - -
    -
    -

    Set whether SO_linger keep alive is enabled

    -
    -
    -
    param
    -

    true if SO_linger is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set whether SSL/TLS is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - -
    -
    -

    Enable the {@code TCP_CORK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the cork value

    -
    -
    -
    -
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - -
    -
    -

    Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

    -
    -
    -
    param
    -

    the fast open value

    -
    -
    -
    -
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - -
    -
    -

    Set whether TCP keep alive is enabled

    -
    -
    -
    param
    -

    true if TCP keep alive is enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - -
    -
    -

    Set whether TCP no delay is enabled

    -
    -
    -
    param
    -

    true if TCP no delay is enabled (Nagle disabled)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - -
    -
    -

    Enable the {@code TCP_QUICKACK} option - only with linux native transport.

    -
    -
    -
    param
    -

    the quick ack value

    -
    -
    -
    -
    -
    - -

    trafficClass

    -
    trafficClass: number
    - -
    -
    -

    Set the value of traffic class

    -
    -
    -
    param
    -

    the value of traffic class

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    trustAll

    -
    trustAll: boolean
    - -
    -
    -

    Set whether all server certificates should be trusted

    -
    -
    -
    param
    -

    true if all should be trusted

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - -
    -
    -

    Set the trust options in jks format, aka Java truststore

    -
    -
    -
    param
    -

    the trust options in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - -
    -
    -

    Set the ALPN usage.

    -
    -
    -
    param
    -

    true when Application-Layer Protocol Negotiation should be used

    -
    -
    -
    -
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - -
    -
    -

    Set whether Netty pooled buffers are enabled

    -
    -
    -
    param
    -

    true if pooled buffers enabled

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Module
      • -
    • Object literal
      • -
    • Variable
      • -
    • Function
      • -
    • Function with type parameter
      • -
    • Index signature
      • -
    • Type alias
      • -
    -
      -
    • Enumeration
      • -
    • Enumeration member
      • -
    • Property
      • -
    • Method
      • -
    -
      -
    • Interface
      • -
    • Interface with type parameter
      • -
    • Constructor
      • -
    • Property
      • -
    • Method
      • -
    • Index signature
      • -
    -
      -
    • Class
      • -
    • Class with type parameter
      • -
    • Constructor
      • -
    • Property
      • -
    • Method
      • -
    • Accessor
      • -
    • Index signature
      • -
    -
      -
    • Inherited constructor
      • -
    • Inherited property
      • -
    • Inherited method
      • -
    • Inherited accessor
      • -
    -
      -
    • Protected property
      • -
    • Protected method
      • -
    • Protected accessor
      • -
    -
      -
    • Private property
      • -
    • Private method
      • -
    • Private accessor
      • -
    -
      -
    • Static property
      • -
    • Static method
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - - \ No newline at end of file diff --git a/docs/@vertx/auth-common/interfaces/authoptions.html b/docs/@vertx/core/interfaces/handler.html similarity index 74% rename from docs/@vertx/auth-common/interfaces/authoptions.html rename to docs/@vertx/core/interfaces/handler.html index 28bf78fba..e0588453a 100644 --- a/docs/@vertx/auth-common/interfaces/authoptions.html +++ b/docs/@vertx/core/interfaces/handler.html @@ -3,7 +3,7 @@ - AuthOptions | @vertx/auth-common + Handler | @vertx/core @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/auth-common + @vertx/core
    @@ -54,24 +54,78 @@ Globals
  • - AuthOptions + Handler
    • -

    Interface AuthOptions

    +

    Interface Handler<T>

    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Hierarchy

    • - AuthOptions + Handler
    +
    +

    Implemented by

    + +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    handle

    +
      +
    • handle(arg0: T): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        arg0: T
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    +
    +

    Implemented by

    + +

    Index

    @@ -97,16 +110,21 @@

    isMetricsEnabled

  • -

    Whether the metrics are enabled for this measured object

    +

    Whether the metrics are enabled for this measured object

    +
    +
    implspec
    +

    The default implementation returns {@code false}

    +
    +

    Returns boolean

    -

    true if the metrics are enabled

    +

    if metrics are enabled

    • diff --git a/docs/@vertx/core/interfaces/networkoptions.html b/docs/@vertx/core/interfaces/networkoptions.html deleted file mode 100644 index c12d8ee61..000000000 --- a/docs/@vertx/core/interfaces/networkoptions.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - NetworkOptions | @vertx/core - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Interface NetworkOptions

    -
    -
    -
    -
    -
    -
    -
    -

    Hierarchy

    -
      -
    • - NetworkOptions -
      • -
    -
    -
    -

    Index

    -
    -
    -
    -

    Properties

    - -
    -
    -
    -
    -
    -

    Properties

    -
    - -

    logActivity

    -
    logActivity: boolean
    - -
    -
    -

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    -
    -
    -
    param
    -

    true for logging the network activity

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - -
    -
    -

    Set the TCP receive buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - -
    -
    -

    Set the value of reuse address

    -
    -
    -
    param
    -

    the value of reuse address

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    reusePort

    -
    reusePort: boolean
    - -
    -
    -

    Set the value of reuse port. -

    - This is only supported by native transports.

    -
    -
    -
    param
    -

    the value of reuse port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - -
    -
    -

    Set the TCP send buffer size

    -
    -
    -
    param
    -

    the buffers size, in bytes

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    - -

    trafficClass

    -
    trafficClass: number
    - -
    -
    -

    Set the value of traffic class

    -
    -
    -
    param
    -

    the value of traffic class

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Module
      • -
    • Object literal
      • -
    • Variable
      • -
    • Function
      • -
    • Function with type parameter
      • -
    • Index signature
      • -
    • Type alias
      • -
    -
      -
    • Enumeration
      • -
    • Enumeration member
      • -
    • Property
      • -
    • Method
      • -
    -
      -
    • Interface
      • -
    • Interface with type parameter
      • -
    • Constructor
      • -
    • Property
      • -
    • Method
      • -
    • Index signature
      • -
    -
      -
    • Class
      • -
    • Class with type parameter
      • -
    • Constructor
      • -
    • Property
      • -
    • Method
      • -
    • Accessor
      • -
    • Index signature
      • -
    -
      -
    • Inherited constructor
      • -
    • Inherited property
      • -
    • Inherited method
      • -
    • Inherited accessor
      • -
    -
      -
    • Protected property
      • -
    • Protected method
      • -
    • Protected accessor
      • -
    -
      -
    • Private property
      • -
    • Private method
      • -
    • Private accessor
      • -
    -
      -
    • Static property
      • -
    • Static method
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - - \ No newline at end of file diff --git a/docs/@vertx/core/interfaces/readstream.html b/docs/@vertx/core/interfaces/readstream.html index 5158fa458..a89b8c938 100644 --- a/docs/@vertx/core/interfaces/readstream.html +++ b/docs/@vertx/core/interfaces/readstream.html @@ -57,21 +57,55 @@ ReadStream -

    Interface ReadStream

    +

    Interface ReadStream<T>

    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Hierarchy

    +
    +

    Implemented by

    + +

    Index

    @@ -80,7 +114,8 @@

    Index

    Methods

    • endHandler
      • -
    • exceptionHandler
      • +
    • exceptionHandler
      • +
    • fetch
    • handler
    • pause
    • resume
      • @@ -95,18 +130,18 @@

      Methods

      endHandler

      • -

        Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

        +

        Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

        Parameters

        @@ -116,17 +151,19 @@
        endHandler: function
          • -
          • (result: void): void | null | undefined
            • +
          • (res: void): void | Handler<void> | null | undefined

          • Parameters

            • -
              result: void
              +
              res: void

            Returns void + | + Handler<void> | null | @@ -138,27 +175,28 @@

            Returns void

          -

          Returns ReadStream

          +

          Returns ReadStream<T>

          a reference to this, so the API can be used fluently

    -
    +

    exceptionHandler

    -
      -
    • exceptionHandler(handler: function): ReadStream
      • +
        +
      • exceptionHandler(handler: function): ReadStream<T>
      • -

        Set an exception handler on the read stream.

        +

        Set an exception handler on the read stream.

        Parameters

        @@ -171,17 +209,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -193,7 +233,38 @@

            Returns void

          -

          Returns ReadStream

          +

          Returns ReadStream<T>

          +

          a reference to this, so the API can be used fluently

          +
          • +
        +
    +
    + +

    fetch

    + +
      +
    • + +
      +
      +

      Fetch the specified {@code amount} of elements. If the {@code ReadStream} has been paused, reading will + recommence with the specified {@code amount} of items, otherwise the specified {@code amount} will + be added to the current stream demand.

      +
      +
      +

      Parameters

      +
        +
      • +
        amount: number
        +
        • +
      +

      Returns ReadStream<T>

      a reference to this, so the API can be used fluently

    @@ -202,18 +273,18 @@

    Returns

    handler

    • -

      Set a data handler. As data is read, the handler will be called with the data.

      +

      Set a data handler. As data is read, the handler will be called with the data.

      Parameters

      @@ -223,17 +294,19 @@
      handler: function
        • -
        • (result: any): void | null | undefined
          • +
        • (res: T): void | Handler<T> | null | undefined

        • Parameters

          • -
            result: any
            +
            res: T

          Returns void + | + Handler<T> | null | @@ -245,7 +318,7 @@

          Returns void

        -

        Returns ReadStream

        +

        Returns ReadStream<T>

        a reference to this, so the API can be used fluently

      @@ -254,21 +327,23 @@

      Returns

      pause

      • -

        Pause the {@code ReadSupport}. While it's paused, no data will be sent to the {@code dataHandler}

        +

        Pause the {@code ReadStream}, it sets the buffer in {@code fetch} mode and clears the actual demand. +

        + While it's paused, no data will be sent to the data {@code handler}.

        -

        Returns ReadStream

        +

        Returns ReadStream<T>

        a reference to this, so the API can be used fluently

      @@ -277,21 +352,23 @@

      Returns

      resume

      • -

        Resume reading. If the {@code ReadSupport} has been paused, reading will recommence on it.

        +

        Resume reading, and sets the buffer in {@code flowing} mode. +

        + If the {@code ReadStream} has been paused, reading will recommence on it.

        -

        Returns ReadStream

        +

        Returns ReadStream<T>

        a reference to this, so the API can be used fluently

      @@ -310,15 +387,18 @@

      Returns

      -
    • +
    • ReadStream
      • endHandler
        • -
      • +
      • exceptionHandler
        • +
      • + fetch +
      • handler
        • diff --git a/docs/@vertx/core/interfaces/streambase.html b/docs/@vertx/core/interfaces/streambase.html index 3f1abb162..93a5f8140 100644 --- a/docs/@vertx/core/interfaces/streambase.html +++ b/docs/@vertx/core/interfaces/streambase.html @@ -69,6 +69,14 @@

        Hierarchy

    @@ -97,12 +105,12 @@

    exceptionHandler

  • -

    Set an exception handler.

    +

    Set an exception handler.

    Parameters

    @@ -115,17 +123,19 @@
    handler: function
      • -
      • (result: Error): void | null | undefined
        • +
      • (res: Error): void | Handler<Error> | null | undefined

      • Parameters

        • -
          result: Error
          +
          res: Error

        Returns void + | + Handler<Error> | null | diff --git a/docs/@vertx/core/interfaces/tcpssloptions.html b/docs/@vertx/core/interfaces/tcpssloptions.html deleted file mode 100644 index ed18647d0..000000000 --- a/docs/@vertx/core/interfaces/tcpssloptions.html +++ /dev/null @@ -1,908 +0,0 @@ - - - - - - TCPSSLOptions | @vertx/core - - - - - -
        -
        -
        -
        - -
        -
        - Options -
        -
        - All -
          -
        • Public
          • -
        • Public/Protected
          • -
        • All
          • -
        -
        - - - - -
        -
        - Menu -
        -
        -
        -
        -
        -
        - -

        Interface TCPSSLOptions

        -
        -
        -
        -
        -
        -
        -
        -

        Hierarchy

        -
          -
        • - TCPSSLOptions -
          • -
        -
        -
        -

        Index

        -
        -
        -
        -

        Properties

        - -
        -
        -
        -
        -
        -

        Properties

        -
        - -

        crlPaths

        -
        crlPaths: string
        - -
        -
        -

        Add a CRL path

        -
        -
        -
        param
        -

        the path

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        throws
        -

        NullPointerException

        -
        -
        -
        -
        -
        - -

        crlValues

        -
        crlValues: Buffer
        - -
        -
        -

        Add a CRL value

        -
        -
        -
        param
        -

        the value

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        throws
        -

        NullPointerException

        -
        -
        -
        -
        -
        - -

        enabledCipherSuites

        -
        enabledCipherSuites: string
        - -
        -
        -

        Add an enabled cipher suite, appended to the ordered suites.

        -
        -
        -
        param
        -

        the suite

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        enabledSecureTransportProtocols

        -
        enabledSecureTransportProtocols: string
        - -
        -
        -

        Sets the list of enabled SSL/TLS protocols.

        -
        -
        -
        param
        -

        the SSL/TLS protocols to enable

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        idleTimeout

        -
        idleTimeout: number
        - -
        -
        -

        Set the idle timeout, in seconds. zero means don't timeout. - This determines if a connection will timeout and be closed if no data is received within the timeout.

        -
        -
        -
        param
        -

        the timeout, in seconds

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        jdkSslEngineOptions

        -
        jdkSslEngineOptions: JdkSSLEngineOptions
        - -
        -
        - -

        keyStoreOptions

        -
        keyStoreOptions: JksOptions
        - -
        -
        -

        Set the key/cert options in jks format, aka Java keystore.

        -
        -
        -
        param
        -

        the key store in jks format

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        logActivity

        -
        logActivity: boolean
        - -
        -
        -

        Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

        -
        -
        -
        param
        -

        true for logging the network activity

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        openSslEngineOptions

        -
        openSslEngineOptions: OpenSSLEngineOptions
        - -
        -
        - -

        pemKeyCertOptions

        -
        pemKeyCertOptions: PemKeyCertOptions
        - -
        -
        -

        Set the key/cert store options in pem format.

        -
        -
        -
        param
        -

        the options in pem format

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        pemTrustOptions

        -
        pemTrustOptions: PemTrustOptions
        - -
        -
        -

        Set the trust options in pem format

        -
        -
        -
        param
        -

        the trust options in pem format

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        pfxKeyCertOptions

        -
        pfxKeyCertOptions: PfxOptions
        - -
        -
        -

        Set the key/cert options in pfx format.

        -
        -
        -
        param
        -

        the key cert options in pfx format

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        pfxTrustOptions

        -
        pfxTrustOptions: PfxOptions
        - -
        -
        -

        Set the trust options in pfx format

        -
        -
        -
        param
        -

        the trust options in pfx format

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        receiveBufferSize

        -
        receiveBufferSize: number
        - -
        -
        -

        Set the TCP receive buffer size

        -
        -
        -
        param
        -

        the buffers size, in bytes

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        reuseAddress

        -
        reuseAddress: boolean
        - -
        -
        -

        Set the value of reuse address

        -
        -
        -
        param
        -

        the value of reuse address

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        reusePort

        -
        reusePort: boolean
        - -
        -
        -

        Set the value of reuse port. -

        - This is only supported by native transports.

        -
        -
        -
        param
        -

        the value of reuse port

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        sendBufferSize

        -
        sendBufferSize: number
        - -
        -
        -

        Set the TCP send buffer size

        -
        -
        -
        param
        -

        the buffers size, in bytes

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        soLinger

        -
        soLinger: number
        - -
        -
        -

        Set whether SO_linger keep alive is enabled

        -
        -
        -
        param
        -

        true if SO_linger is enabled

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        ssl

        -
        ssl: boolean
        - -
        -
        -

        Set whether SSL/TLS is enabled

        -
        -
        -
        param
        -

        true if enabled

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        tcpCork

        -
        tcpCork: boolean
        - -
        -
        -

        Enable the {@code TCP_CORK} option - only with linux native transport.

        -
        -
        -
        param
        -

        the cork value

        -
        -
        -
        -
        -
        - -

        tcpFastOpen

        -
        tcpFastOpen: boolean
        - -
        -
        -

        Enable the {@code TCP_FASTOPEN} option - only with linux native transport.

        -
        -
        -
        param
        -

        the fast open value

        -
        -
        -
        -
        -
        - -

        tcpKeepAlive

        -
        tcpKeepAlive: boolean
        - -
        -
        -

        Set whether TCP keep alive is enabled

        -
        -
        -
        param
        -

        true if TCP keep alive is enabled

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        tcpNoDelay

        -
        tcpNoDelay: boolean
        - -
        -
        -

        Set whether TCP no delay is enabled

        -
        -
        -
        param
        -

        true if TCP no delay is enabled (Nagle disabled)

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        tcpQuickAck

        -
        tcpQuickAck: boolean
        - -
        -
        -

        Enable the {@code TCP_QUICKACK} option - only with linux native transport.

        -
        -
        -
        param
        -

        the quick ack value

        -
        -
        -
        -
        -
        - -

        trafficClass

        -
        trafficClass: number
        - -
        -
        -

        Set the value of traffic class

        -
        -
        -
        param
        -

        the value of traffic class

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        trustStoreOptions

        -
        trustStoreOptions: JksOptions
        - -
        -
        -

        Set the trust options in jks format, aka Java truststore

        -
        -
        -
        param
        -

        the trust options in jks format

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        - -

        useAlpn

        -
        useAlpn: boolean
        - -
        -
        -

        Set the ALPN usage.

        -
        -
        -
        param
        -

        true when Application-Layer Protocol Negotiation should be used

        -
        -
        -
        -
        -
        - -

        usePooledBuffers

        -
        usePooledBuffers: boolean
        - -
        -
        -

        Set whether Netty pooled buffers are enabled

        -
        -
        -
        param
        -

        true if pooled buffers enabled

        -
        -
        returns
        -

        a reference to this, so the API can be used fluently

        -
        -
        -
        -
        -
        -
        -
        - - -
        -
        -
        -
        -
        -

        Legend

        -
        -
          -
        • Module
          • -
        • Object literal
          • -
        • Variable
          • -
        • Function
          • -
        • Function with type parameter
          • -
        • Index signature
          • -
        • Type alias
          • -
        -
          -
        • Enumeration
          • -
        • Enumeration member
          • -
        • Property
          • -
        • Method
          • -
        -
          -
        • Interface
          • -
        • Interface with type parameter
          • -
        • Constructor
          • -
        • Property
          • -
        • Method
          • -
        • Index signature
          • -
        -
          -
        • Class
          • -
        • Class with type parameter
          • -
        • Constructor
          • -
        • Property
          • -
        • Method
          • -
        • Accessor
          • -
        • Index signature
          • -
        -
          -
        • Inherited constructor
          • -
        • Inherited property
          • -
        • Inherited method
          • -
        • Inherited accessor
          • -
        -
          -
        • Protected property
          • -
        • Protected method
          • -
        • Protected accessor
          • -
        -
          -
        • Private property
          • -
        • Private method
          • -
        • Private accessor
          • -
        -
          -
        • Static property
          • -
        • Static method
          • -
        -
        -
        -
        -
        -

        Generated using TypeDoc

        -
        -
        - - - - \ No newline at end of file diff --git a/docs/@vertx/core/interfaces/websocketbase.html b/docs/@vertx/core/interfaces/websocketbase.html index 3128e868d..f4fca3d56 100644 --- a/docs/@vertx/core/interfaces/websocketbase.html +++ b/docs/@vertx/core/interfaces/websocketbase.html @@ -68,10 +68,25 @@

        Interface WebSocketBase

        Hierarchy

    • +
    +

    Implemented by

    + +

    Index

    @@ -83,30 +98,31 @@

    Methods

  • binaryMessageHandler
  • close
  • closeHandler
    • -
  • drainHandler
    • -
  • end
    • -
  • endHandler
    • -
  • exceptionHandler
    • +
  • drainHandler
    • +
  • end
    • +
  • endHandler
    • +
  • exceptionHandler
    • +
  • fetch
  • frameHandler
    • -
  • handler
    • +
  • handler
  • isSsl
  • localAddress
    • -
  • pause
    • +
  • pause
  • pongHandler
  • remoteAddress
    • -
  • resume
    • -
  • setWriteQueueMaxSize
    • +
  • resume
    • +
  • setWriteQueueMaxSize
  • subProtocol
  • textHandlerID
  • textMessageHandler
    • -
  • write
    • +
  • write
  • writeBinaryMessage
  • writeFinalBinaryFrame
  • writeFinalTextFrame
  • writeFrame
  • writePing
  • writePong
    • -
  • writeQueueFull
    • +
  • writeQueueFull
  • writeTextMessage
    • @@ -125,12 +141,12 @@

    binaryHandlerID

  • -

    When a {@code Websocket} is created it automatically registers an event handler with the event bus - the ID of that +

    When a {@code Websocket} is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

    Given this ID, a different event loop can send a binary frame to that event handler using the event bus and @@ -153,12 +169,12 @@

    binaryMessageHandler

  • -

    Set a binary message handler on the connection. This handler serves a similar purpose to {@link #handler(Handler)} +

    Set a binary message handler on the connection. This handler serves a similar purpose to {@link #handler(Handler)} except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using {@link WebSocketFrame#isFinal()} to find the boundaries).

    @@ -173,17 +189,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<Buffer> | null | @@ -212,12 +230,14 @@

        close

      • -

        Close the WebSocket.

        +

        Close the WebSocket sending the default close frame. +

        + No more messages can be sent.

        Returns void

        @@ -225,7 +245,7 @@

        Returns void

        Parameters

        @@ -239,7 +259,7 @@

        Returns void

        Parameters

        @@ -265,12 +285,14 @@

        closeHandler

      • -

        Set a close handler. This will be called when the WebSocket is closed.

        +

        Set a close handler. This will be called when the WebSocket is closed. +

        + After this callback, no more messages are expected.

        Parameters

        @@ -283,17 +305,19 @@
        handler: function
          • -
          • (result: void): void | null | undefined
            • +
          • (res: void): void | Handler<void> | null | undefined

          • Parameters

            • -
              result: void
              +
              res: void

            Returns void + | + Handler<void> | null | @@ -310,17 +334,18 @@

            Returns +

            drainHandler

            -
              +

              • Parameters

                @@ -330,17 +355,19 @@
                handler: function
                  • -
                  • (result: void): void | null | undefined
                    • +
                  • (res: void): void | Handler<void> | null | undefined

                  • Parameters

                    • -
                      result: void
                      +
                      res: void

                    Returns void + | + Handler<void> | null | @@ -356,23 +383,24 @@

                    Returns +

                    end

                    -
                      +
                      • end(t: Buffer): void
                      • end(): void
                      • -

                        Same as {@link #end()} but writes some data to the stream before ending.

                        +

                        Same as {@link #end()} but writes some data to the stream before ending.

                        Parameters

                        @@ -385,30 +413,32 @@

                        Returns void
                      • -

                        Calls {@link #close()}

                        +

                        Calls {@link #close()}

                        Returns void

                    -
                    +

                    endHandler

                    -
                      +

                      • Parameters

                        @@ -418,17 +448,19 @@
                        endHandler: function
                          • -
                          • (result: void): void | null | undefined
                            • +
                          • (res: void): void | Handler<void> | null | undefined

                          • Parameters

                            • -
                              result: void
                              +
                              res: void

                            Returns void + | + Handler<void> | null | @@ -444,17 +476,18 @@

                            Returns +

                            exceptionHandler

                            -
                              +

                              • Parameters

                                @@ -464,17 +497,19 @@
                                handler: function
                                  • -
                                  • (result: Error): void | null | undefined
                                    • +
                                  • (res: Error): void | Handler<Error> | null | undefined

                                  • Parameters

                                    • -
                                      result: Error
                                      +
                                      res: Error

                                    Returns void + | + Handler<Error> | null | @@ -490,6 +525,30 @@

                                    Returns + +

                                    fetch

                                    + + +

                            frameHandler

                            @@ -500,12 +559,12 @@

                            frameHandler

                          • -

                            Set a frame handler on the connection. This handler will be called when frames are read on the connection.

                            +

                            Set a frame handler on the connection. This handler will be called when frames are read on the connection.

                            Parameters

                            @@ -518,17 +577,19 @@
                            handler: function

                              • Parameters

                                Returns void + | + Handler<WebSocketFrame> | null | @@ -545,17 +606,18 @@

                                Returns +

                                handler

                                -
                                  +

                                  • Parameters

                                    @@ -565,17 +627,19 @@
                                    handler: function

                                      • Parameters

                                        Returns void + | + Handler<Buffer> | null | @@ -601,7 +665,7 @@

                                        isSsl

                                      • @@ -621,7 +685,7 @@

                                        localAddress

                                      • @@ -631,17 +695,18 @@

                                        Returns

                                -
                                +

                                pause

                                -
                                  +

                                  • Returns WebSocketBase

                                    @@ -658,12 +723,12 @@

                                    pongHandler

                                  • -

                                    Set a pong message handler on the connection. This handler will be invoked every time a pong message is received +

                                    Set a pong message handler on the connection. This handler will be invoked every time a pong message is received on the server, and can be used by both clients and servers since the RFC 6455 Sections 5.5.2 and 5.5.3 do not specify whether the client or server sends a ping.

                                    @@ -684,17 +749,19 @@

                                    handler: function

                                      • Parameters

                                        Returns void + | + Handler<Buffer> | null | @@ -721,7 +788,7 @@

                                        remoteAddress

                                      • @@ -731,34 +798,36 @@

                                        Returns

                                -
                                +

                                resume

                                -
                                -
                                +

                                setWriteQueueMaxSize

                                -
                                  +

                                  • Parameters

                                    @@ -781,12 +850,12 @@

                                    subProtocol

                                  • -

                                    Returns the websocket sub protocol selected by the websocket handshake. +

                                    Returns the websocket sub protocol selected by the websocket handshake.

                                    On the server, the value will be {@code null} when the handler receives the websocket callback as the handshake will not be completed yet.

                                    @@ -806,12 +875,12 @@

                                    textHandlerID

                                  • -

                                    When a {@code Websocket} is created it automatically registers an event handler with the eventbus, the ID of that +

                                    When a {@code Websocket} is created it automatically registers an event handler with the eventbus, the ID of that handler is given by {@code textHandlerID}.

                                    Given this ID, a different event loop can send a text frame to that event handler using the event bus and @@ -833,12 +902,12 @@

                                    textMessageHandler

                                  • -

                                    Set a text message handler on the connection. This handler will be called similar to the +

                                    Set a text message handler on the connection. This handler will be called similar to the {@link #binaryMessageHandler(Handler)}, but the buffer will be converted to a String first

                                    @@ -852,17 +921,19 @@
                                    handler: function
                                      • -
                                      • (result: string): void | null | undefined
                                        • +
                                      • (res: string): void | Handler<string> | null | undefined

                                      • Parameters

                                        • -
                                          result: string
                                          +
                                          res: string

                                        Returns void + | + Handler<string> | null | @@ -879,17 +950,18 @@

                                        Returns +

                                        write

                                        -
                                          +

                                          • Parameters

                                            @@ -912,12 +984,12 @@

                                            writeBinaryMessage

                                          • -

                                            Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames +

                                            Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

                                            @@ -945,12 +1017,12 @@

                                            writeFinalBinaryFrame

                                          • -

                                            Write a final WebSocket binary frame to the connection

                                            +

                                            Write a final WebSocket binary frame to the connection

                                            Parameters

                                            @@ -977,12 +1049,12 @@

                                            writeFinalTextFrame

                                          • -

                                            Write a final WebSocket text frame to the connection

                                            +

                                            Write a final WebSocket text frame to the connection

                                            Parameters

                                            @@ -1009,12 +1081,12 @@

                                            writeFrame

                                          • -

                                            Write a WebSocket frame to the connection

                                            +

                                            Write a WebSocket frame to the connection

                                            Parameters

                                            @@ -1041,12 +1113,12 @@

                                            writePing

                                          • -

                                            Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets). +

                                            Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

                                            This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2. @@ -1079,12 +1151,12 @@

                                            writePong

                                          • -

                                            Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets). +

                                            Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

                                            This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2. @@ -1108,22 +1180,23 @@

                                            Returns +

                                            writeQueueFull

                                            -
                                              +
                                              • writeQueueFull(): boolean
                                              • -

                                                This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                                +

                                                This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                                #setWriteQueueMaxSize}

                                                @@ -1142,12 +1215,12 @@

                                                writeTextMessage

                                              • -

                                                Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames +

                                                Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

                                                @@ -1194,22 +1267,25 @@

                                                Returns closeHandler

                                                • -
                                              • +
                                              • drainHandler
                                                • -
                                              • +
                                              • end
                                                • -
                                              • +
                                              • endHandler
                                                • -
                                              • +
                                              • exceptionHandler
                                                • +
                                              • + fetch +
                                              • frameHandler
                                                • -
                                              • +
                                              • handler
                                              • @@ -1218,7 +1294,7 @@

                                                Returns localAddress

                                                • -
                                              • +
                                              • pause
                                              • @@ -1227,10 +1303,10 @@

                                                Returns remoteAddress

                                                • -
                                              • +
                                              • resume
                                                • -
                                              • +
                                              • setWriteQueueMaxSize
                                              • @@ -1242,7 +1318,7 @@

                                                Returns textMessageHandler

                                                • -
                                              • +
                                              • write
                                              • @@ -1263,7 +1339,7 @@

                                                Returns writePong

                                                • -
                                              • +
                                              • writeQueueFull
                                              • diff --git a/docs/@vertx/core/interfaces/writestream.html b/docs/@vertx/core/interfaces/writestream.html index b48cf31f0..55a4f7eec 100644 --- a/docs/@vertx/core/interfaces/writestream.html +++ b/docs/@vertx/core/interfaces/writestream.html @@ -57,21 +57,49 @@ WriteStream
                                              -

                                              Interface WriteStream

                                              +

                                              Interface WriteStream<T>

                                            +
                                            +

                                            Type parameters

                                            +
                                              +
                                            • +

                                              T

                                              +
                                              • +
                                            +

                                            Hierarchy

                                            +
                                            +

                                            Implemented by

                                            + +

                                            Index

                                            @@ -81,7 +109,7 @@

                                            Methods

                                            -
                                            +

                                            exceptionHandler

                                            -
                                              -
                                            • exceptionHandler(handler: function): WriteStream
                                              • +
                                                +
                                              • exceptionHandler(handler: function): WriteStream<T>
                                              • -

                                                Set an exception handler on the write stream.

                                                +

                                                Set an exception handler on the write stream.

                                                Parameters

                                                @@ -223,17 +254,19 @@
                                                handler: function
                                                  • -
                                                  • (result: Error): void | null | undefined
                                                    • +
                                                  • (res: Error): void | Handler<Error> | null | undefined

                                                  • Parameters

                                                    • -
                                                      result: Error
                                                      +
                                                      res: Error

                                                    Returns void + | + Handler<Error> | null | @@ -245,7 +278,7 @@

                                                    Returns void

                                                  -

                                                  Returns WriteStream

                                                  +

                                                  Returns WriteStream<T>

                                                  a reference to this, so the API can be used fluently

                                                @@ -254,18 +287,18 @@

                                                Returns

                                                setWriteQueueMaxSize

                                                  -
                                                • setWriteQueueMaxSize(maxSize: number): WriteStream
                                                  • +
                                                • setWriteQueueMaxSize(maxSize: number): WriteStream<T>
                                                • -

                                                  Set the maximum size of the write queue to {@code maxSize}. You will still be able to write to the stream even +

                                                  Set the maximum size of the write queue to {@code maxSize}. You will still be able to write to the stream even if there is more than {@code maxSize} items in the write queue. This is used as an indicator by classes such as {@code Pump} to provide flow control.

                                                  @@ -283,7 +316,7 @@

                                                  maxSize: number
                                                -

                                                Returns WriteStream

                                                +

                                                Returns WriteStream<T>

                                                a reference to this, so the API can be used fluently

                                              @@ -292,18 +325,18 @@

                                              Returns

                                              write

                                              • -

                                                Write some data to the stream. The data is put on an internal write queue, and the write actually happens +

                                                Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the {@link #writeQueueFull} method before writing. This is done automatically if using a Pump.

                                                @@ -311,13 +344,13 @@

                                                write

                                                Parameters

                                                • -
                                                  data: any
                                                  +
                                                  data: T

                                                  the data to write

                                                -

                                                Returns WriteStream

                                                +

                                                Returns WriteStream<T>

                                                a reference to this, so the API can be used fluently

                                              @@ -332,12 +365,12 @@

                                              writeQueueFull

                                            • -

                                              This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                              +

                                              This will return {@code true} if there are more bytes in the write queue than the value set using {@link

                                              #setWriteQueueMaxSize}

                                              @@ -360,7 +393,7 @@

                                              Returns boolean

                                Variables

                                +
                                + +

                                Const Java

                                +
                                Java: object
                                + +
                                +

                                Type declaration

                                +
                                  +
                                • +
                                  from: function
                                  +
                                    +
                                  • from(value: any): any
                                    • +
                                  +
                                    +
                                  • + +
                                    +
                                    +

                                    The from function creates a shallow copy of the Java datastructure (Array, List) as a JavaScript array.

                                    +
                                    +

                                    In many cases, this is not necessary, you can typically use the Java datastructure directly + from JavaScript.

                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • +
                                      value: any
                                      +
                                      +
                                      +
                                      • +
                                    +

                                    Returns any

                                    +
                                    • +
                                  • +
                                • +
                                  isJavaObject: function
                                  +
                                    +
                                  • isJavaObject(obj: any): boolean
                                    • +
                                  +
                                    +
                                  • + +
                                    +
                                    +

                                    The isJavaObject method returns whether obj is an object of the Java language.

                                    +
                                    +

                                    It returns false for native JavaScript objects, as well as for objects of other polyglot languages.

                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • +
                                      obj: any
                                      +
                                      +
                                      +
                                      • +
                                    +

                                    Returns boolean

                                    +
                                    • +
                                  • +
                                • +
                                  isType: function
                                  +
                                    +
                                  • isType(obj: any): boolean
                                    • +
                                  +
                                    +
                                  • + +
                                    +
                                    +

                                    The isType method returns whether obj is an object of the Java language, + representing a Java Class instance. It returns false for all other arguments.

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • +
                                      obj: any
                                      +
                                      +
                                      +
                                      • +
                                    +

                                    Returns boolean

                                    +
                                    • +
                                  • +
                                • +
                                  to: function
                                  +
                                    +
                                  • to(jsValue: any, javaType: any): any
                                    • +
                                  +
                                    +
                                  • + +
                                    +
                                    +

                                    The to function converts the argument to a Java dataype.

                                    +
                                    +

                                    When no toType is provided, Object[] is assumed.

                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • +
                                      jsValue: any
                                      +
                                      • +
                                    • +
                                      javaType: any
                                      +
                                      +
                                      +
                                      • +
                                    +

                                    Returns any

                                    +
                                    • +
                                  • +
                                • +
                                  type: function
                                  +
                                    +
                                  • type(className: string): any
                                    • +
                                  +
                                    +
                                  • + +
                                    +
                                    +

                                    The type function loads the specified Java class and provides it as an object.

                                    +
                                    +

                                    Fields of this object can be read directly from it, and new instances can be created with the + JavaScript new keyword.

                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • +
                                      className: string
                                      +
                                      +
                                      +
                                      • +
                                    +

                                    Returns any

                                    +
                                    • +
                                  • +
                                • +
                                  typeName: function
                                  +
                                    +
                                  • typeName(obj: any): string | undefined
                                    • +
                                  +
                                    +
                                  • + +
                                    +
                                    +

                                    The typeName method returns the Java Class name of obj. obj is expected to represent + a Java Class instance, i.e., isType(obj) should return true; otherwise, undefined is returned.

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • +
                                      obj: any
                                      +
                                      +
                                      +
                                      • +
                                    +

                                    Returns string + | + undefined +

                                    +
                                    • +
                                  • +
                                +
                                +
                                +
                                + +

                                Const process

                                +
                                process: object
                                + +
                                +

                                Type declaration

                                +
                                  +
                                • +
                                  engine: String
                                  +
                                  • +
                                • +
                                  env: object
                                  +
                                    +
                                  • +
                                    [key: string]: string
                                    +
                                    • +
                                  +
                                  • +
                                • +
                                  exit: function
                                  +
                                    +
                                  • +
                                      +
                                    • (exitCode: Number): void
                                      • +
                                    +
                                      +
                                    • +

                                      Parameters

                                      +
                                        +
                                      • +
                                        exitCode: Number
                                        +
                                        • +
                                      +

                                      Returns void

                                      +
                                      • +
                                    +
                                    • +
                                  +
                                  • +
                                • +
                                  nextTick: function
                                  +
                                    +
                                  • +
                                      +
                                    • (callback: function): void
                                      • +
                                    +
                                      +
                                    • +

                                      Parameters

                                      +
                                        +
                                      • +
                                        callback: function
                                        +
                                          +
                                        • +
                                            +
                                          • (...args: any[]): void
                                            • +
                                          +
                                            +
                                          • +

                                            Parameters

                                            +
                                              +
                                            • +
                                              Rest ...args: any[]
                                              +
                                              • +
                                            +

                                            Returns void

                                            +
                                            • +
                                          +
                                          • +
                                        +
                                        • +
                                      +

                                      Returns void

                                      +
                                      • +
                                    +
                                    • +
                                  +
                                  • +
                                • +
                                  pid: String
                                  +
                                  • +
                                • +
                                  stderr: any
                                  +
                                  • +
                                • +
                                  stdin: any
                                  +
                                  • +
                                • +
                                  stdout: any
                                  +
                                  • +
                                +
                                +
                                +
                                + +

                                Const require

                                +
                                require: object
                                + +
                                +

                                Type declaration

                                +
                                  +
                                • +
                                    +
                                  • (id: string): any
                                    • +
                                  +
                                    +
                                  • +

                                    Parameters

                                    +
                                      +
                                    • +
                                      id: string
                                      +
                                      • +
                                    +

                                    Returns any

                                    +
                                    • +
                                  +
                                  • +
                                • +
                                  cache: any
                                  +
                                  • +
                                • +
                                  extensions: any
                                  +
                                  • +
                                • +
                                  resolve: function
                                  +
                                    +
                                  • resolve(): string
                                    • +
                                  +
                                  • +
                                +
                                +

                                Const vertx

                                vertx: Vertx
                                +
                                +

                                Functions

                                +
                                + +

                                clearInterval

                                +
                                  +
                                • clearInterval(intervalId: Number): any
                                  • +
                                +
                                  +
                                • + +

                                  Parameters

                                  +
                                    +
                                  • +
                                    intervalId: Number
                                    +
                                    • +
                                  +

                                  Returns any

                                  +
                                  • +
                                +
                                +
                                + +

                                clearTimeout

                                +
                                  +
                                • clearTimeout(timeoutId: Number): any
                                  • +
                                +
                                  +
                                • + +

                                  Parameters

                                  +
                                    +
                                  • +
                                    timeoutId: Number
                                    +
                                    • +
                                  +

                                  Returns any

                                  +
                                  • +
                                +
                                +
                                + +

                                setImmediate

                                +
                                  +
                                • setImmediate(callback: function, ...args: any[]): any
                                  • +
                                +
                                  +
                                • + +

                                  Parameters

                                  +
                                    +
                                  • +
                                    callback: function
                                    +
                                      +
                                    • +
                                        +
                                      • (...args: any[]): void
                                        • +
                                      +
                                        +
                                      • +

                                        Parameters

                                        +
                                          +
                                        • +
                                          Rest ...args: any[]
                                          +
                                          • +
                                        +

                                        Returns void

                                        +
                                        • +
                                      +
                                      • +
                                    +
                                    • +
                                  • +
                                    Rest ...args: any[]
                                    +
                                    • +
                                  +

                                  Returns any

                                  +
                                  • +
                                +
                                +
                                + +

                                setInterval

                                +
                                  +
                                • setInterval(callback: function, ms: number, ...args: any[]): Number
                                  • +
                                +
                                  +
                                • + +

                                  Parameters

                                  +
                                    +
                                  • +
                                    callback: function
                                    +
                                      +
                                    • +
                                        +
                                      • (...args: any[]): void
                                        • +
                                      +
                                        +
                                      • +

                                        Parameters

                                        +
                                          +
                                        • +
                                          Rest ...args: any[]
                                          +
                                          • +
                                        +

                                        Returns void

                                        +
                                        • +
                                      +
                                      • +
                                    +
                                    • +
                                  • +
                                    ms: number
                                    +
                                    • +
                                  • +
                                    Rest ...args: any[]
                                    +
                                    • +
                                  +

                                  Returns Number

                                  +
                                  • +
                                +
                                +
                                + +

                                setTimeout

                                +
                                  +
                                • setTimeout(callback: function, ms: number, ...args: any[]): Number
                                  • +
                                +
                                  +
                                • + +

                                  Parameters

                                  +
                                    +
                                  • +
                                    callback: function
                                    +
                                      +
                                    • +
                                        +
                                      • (...args: any[]): void
                                        • +
                                      +
                                        +
                                      • +

                                        Parameters

                                        +
                                          +
                                        • +
                                          Rest ...args: any[]
                                          +
                                          • +
                                        +

                                        Returns void

                                        +
                                        • +
                                      +
                                      • +
                                    +
                                    • +
                                  • +
                                    ms: number
                                    +
                                    • +
                                  • +
                                    Rest ...args: any[]
                                    +
                                    • +
                                  +

                                  Returns Number

                                  +
                                  • +
                                +
                                +

    diff --git a/docs/@vertx/dropwizard-metrics/assets/js/search.js b/docs/@vertx/dropwizard-metrics/assets/js/search.js index 8b8764794..22097e5a5 100644 --- a/docs/@vertx/dropwizard-metrics/assets/js/search.js +++ b/docs/@vertx/dropwizard-metrics/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"MetricsService","url":"classes/metricsservice.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"create","url":"classes/metricsservice.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MetricsService"},{"id":2,"kind":2048,"name":"getBaseName","url":"classes/metricsservice.html#getbasename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":3,"kind":2048,"name":"metricsNames","url":"classes/metricsservice.html#metricsnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":4,"kind":2048,"name":"getMetricsSnapshot","url":"classes/metricsservice.html#getmetricssnapshot","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":5,"kind":128,"name":"DropwizardMetricsOptions","url":"classes/dropwizardmetricsoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":1024,"name":"baseName","url":"classes/dropwizardmetricsoptions.html#basename","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":7,"kind":1024,"name":"configPath","url":"classes/dropwizardmetricsoptions.html#configpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":8,"kind":1024,"name":"enabled","url":"classes/dropwizardmetricsoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":9,"kind":1024,"name":"jmxDomain","url":"classes/dropwizardmetricsoptions.html#jmxdomain","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":10,"kind":1024,"name":"jmxEnabled","url":"classes/dropwizardmetricsoptions.html#jmxenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":11,"kind":1024,"name":"monitoredEventBusHandlers","url":"classes/dropwizardmetricsoptions.html#monitoredeventbushandlers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":12,"kind":1024,"name":"monitoredHttpClientEndpoints","url":"classes/dropwizardmetricsoptions.html#monitoredhttpclientendpoints","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":13,"kind":1024,"name":"monitoredHttpClientUris","url":"classes/dropwizardmetricsoptions.html#monitoredhttpclienturis","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":14,"kind":1024,"name":"monitoredHttpServerUris","url":"classes/dropwizardmetricsoptions.html#monitoredhttpserveruris","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":15,"kind":1024,"name":"registryName","url":"classes/dropwizardmetricsoptions.html#registryname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":16,"kind":128,"name":"Match","url":"classes/match.html","classes":"tsd-kind-class"},{"id":17,"kind":1024,"name":"alias","url":"classes/match.html#alias","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":18,"kind":1024,"name":"type","url":"classes/match.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":19,"kind":1024,"name":"value","url":"classes/match.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"MetricsService","url":"classes/metricsservice.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"create","url":"classes/metricsservice.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MetricsService"},{"id":2,"kind":2048,"name":"getBaseName","url":"classes/metricsservice.html#getbasename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":3,"kind":2048,"name":"metricsNames","url":"classes/metricsservice.html#metricsnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":4,"kind":2048,"name":"getMetricsSnapshot","url":"classes/metricsservice.html#getmetricssnapshot","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":5,"kind":128,"name":"DropwizardMetricsOptions","url":"classes/dropwizardmetricsoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":512,"name":"constructor","url":"classes/dropwizardmetricsoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":7,"kind":2048,"name":"getBaseName","url":"classes/dropwizardmetricsoptions.html#getbasename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":8,"kind":2048,"name":"setBaseName","url":"classes/dropwizardmetricsoptions.html#setbasename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":9,"kind":2048,"name":"getConfigPath","url":"classes/dropwizardmetricsoptions.html#getconfigpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":10,"kind":2048,"name":"setConfigPath","url":"classes/dropwizardmetricsoptions.html#setconfigpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":11,"kind":2048,"name":"isEnabled","url":"classes/dropwizardmetricsoptions.html#isenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":12,"kind":2048,"name":"setEnabled","url":"classes/dropwizardmetricsoptions.html#setenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":13,"kind":2048,"name":"getJmxDomain","url":"classes/dropwizardmetricsoptions.html#getjmxdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":14,"kind":2048,"name":"setJmxDomain","url":"classes/dropwizardmetricsoptions.html#setjmxdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":15,"kind":2048,"name":"isJmxEnabled","url":"classes/dropwizardmetricsoptions.html#isjmxenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":16,"kind":2048,"name":"setJmxEnabled","url":"classes/dropwizardmetricsoptions.html#setjmxenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":17,"kind":2048,"name":"getMonitoredEventBusHandlers","url":"classes/dropwizardmetricsoptions.html#getmonitoredeventbushandlers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":18,"kind":2048,"name":"addMonitoredEventBusHandler","url":"classes/dropwizardmetricsoptions.html#addmonitoredeventbushandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":19,"kind":2048,"name":"getMonitoredHttpClientEndpoint","url":"classes/dropwizardmetricsoptions.html#getmonitoredhttpclientendpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":20,"kind":2048,"name":"monitoredHttpClientEndpoints","url":"classes/dropwizardmetricsoptions.html#monitoredhttpclientendpoints","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":21,"kind":2048,"name":"addMonitoredHttpClientEndpoint","url":"classes/dropwizardmetricsoptions.html#addmonitoredhttpclientendpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":22,"kind":2048,"name":"getMonitoredHttpClientUris","url":"classes/dropwizardmetricsoptions.html#getmonitoredhttpclienturis","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":23,"kind":2048,"name":"addMonitoredHttpClientUri","url":"classes/dropwizardmetricsoptions.html#addmonitoredhttpclienturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":24,"kind":2048,"name":"getMonitoredHttpServerUris","url":"classes/dropwizardmetricsoptions.html#getmonitoredhttpserveruris","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":25,"kind":2048,"name":"addMonitoredHttpServerUri","url":"classes/dropwizardmetricsoptions.html#addmonitoredhttpserveruri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":26,"kind":2048,"name":"getRegistryName","url":"classes/dropwizardmetricsoptions.html#getregistryname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":27,"kind":2048,"name":"setRegistryName","url":"classes/dropwizardmetricsoptions.html#setregistryname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DropwizardMetricsOptions"},{"id":28,"kind":128,"name":"Match","url":"classes/match.html","classes":"tsd-kind-class"},{"id":29,"kind":512,"name":"constructor","url":"classes/match.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Match"},{"id":30,"kind":2048,"name":"getAlias","url":"classes/match.html#getalias","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":31,"kind":2048,"name":"setAlias","url":"classes/match.html#setalias","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":32,"kind":2048,"name":"getType","url":"classes/match.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":33,"kind":2048,"name":"setType","url":"classes/match.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":34,"kind":2048,"name":"getValue","url":"classes/match.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":35,"kind":2048,"name":"setValue","url":"classes/match.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"}]}; \ No newline at end of file diff --git a/docs/@vertx/dropwizard-metrics/classes/dropwizardmetricsoptions.html b/docs/@vertx/dropwizard-metrics/classes/dropwizardmetricsoptions.html index d52febcc9..2bb92e4b8 100644 --- a/docs/@vertx/dropwizard-metrics/classes/dropwizardmetricsoptions.html +++ b/docs/@vertx/dropwizard-metrics/classes/dropwizardmetricsoptions.html @@ -77,242 +77,621 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    - -

    baseName

    -
    baseName: string
    - -
    -
    -

    Set a custom baseName for metrics.

    -
    -
    -
    param
    -

    the new baseName.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    configPath

    -
    configPath: string
    - -
    -
    -

    Set the path for a config file that contains options in JSON format, to be used to create a new options object. - The file will be looked for on the file system first and then on the classpath if it's not found.

    -
    -
    -
    param
    -

    the file name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addMonitoredEventBusHandler

    + +
      +
    • + +
      +
      +

      Add a monitored event bus handler.

      +
      +
      +

      Parameters

      +
        +
      • +
        monitoredEventBusHandlers: Match
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabled

    -
    enabled: boolean
    - +
    + +

    addMonitoredHttpClientEndpoint

    + +
      +
    • + +
      +
      +

      Add an monitored http client endpoint.

      +
      +
      +

      Parameters

      +
        +
      • +
        monitoredHttpClientEndpoints: Match
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    jmxDomain

    -
    jmxDomain: string
    - -
    -
    -

    Set the JMX domain to use when JMX metrics are enabled.

    -
    -
    -
    param
    -

    the JMX domain

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addMonitoredHttpClientUri

    + +
      +
    • + +
      +
      +

      Add an monitored http client uri.

      +
      +
      +

      Parameters

      +
        +
      • +
        monitoredHttpClientUris: Match
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    jmxEnabled

    -
    jmxEnabled: boolean
    - -
    -
    -

    Set whether JMX will be enabled on the Vert.x instance.

    -
    -
    -
    param
    -

    true if JMX enabled, or false if not.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addMonitoredHttpServerUri

    + +
      +
    • + +
      +
      +

      Add an monitored http server uri.

      +
      +
      +

      Parameters

      +
        +
      • +
        monitoredHttpServerUris: Match
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    monitoredEventBusHandlers

    -
    monitoredEventBusHandlers: Match
    - -
    -
    -

    Add a monitored event bus handler.

    -
    -
    -
    param
    -

    the event bus address match

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getBaseName

    +
      +
    • getBaseName(): string
      • +
    +
      +
    • + +
      +
      +

      Set a custom baseName for metrics.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getConfigPath

    +
      +
    • getConfigPath(): string
      • +
    +
      +
    • + +
      +
      +

      Set the path for a config file that contains options in JSON format, to be used to create a new options object. + The file will be looked for on the file system first and then on the classpath if it's not found.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +
    + +

    getJmxDomain

    +
      +
    • getJmxDomain(): string
      • +
    +
      +
    • + +
      +
      +

      Set the JMX domain to use when JMX metrics are enabled.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMonitoredEventBusHandlers

    +
      +
    • getMonitoredEventBusHandlers(): Match
      • +
    +
      +
    • + +
      +
      +

      Add a monitored event bus handler.

      +
      +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMonitoredHttpClientEndpoint

    +
      +
    • getMonitoredHttpClientEndpoint(): Match
      • +
    +
      +
    • + +
      +
      +

      Returns Match

      +

      the list of monitored http client endpoints

      +
      • +
    +
    +
    + +

    getMonitoredHttpClientUris

    +
      +
    • getMonitoredHttpClientUris(): Match
      • +
    +
      +
    • + +
      +
      +

      Add an monitored http client uri.

      +
      +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getMonitoredHttpServerUris

    +
      +
    • getMonitoredHttpServerUris(): Match
      • +
    +
      +
    • + +
      +
      +

      Add an monitored http server uri.

      +
      +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getRegistryName

    +
      +
    • getRegistryName(): string
      • +
    +
      +
    • + +
      +
      +

      Set the name used for registering the metrics in the Dropwizard shared registry.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isEnabled

    +
      +
    • isEnabled(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isJmxEnabled

    +
      +
    • isJmxEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether JMX will be enabled on the Vert.x instance.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +

    monitoredHttpClientEndpoints

    -
    monitoredHttpClientEndpoints: Match
    - -
    -
    -

    Add an monitored http client endpoint.

    -
    -
    -
    param
    -

    the handler match

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • monitoredHttpClientEndpoints(): Match
      • +
    +
      +
    • + +
      +
      +

      Add an monitored http client endpoint.

      +
      +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    monitoredHttpClientUris

    -
    monitoredHttpClientUris: Match
    - -
    -
    -

    Add an monitored http client uri.

    -
    -
    -
    param
    -

    the handler match

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setBaseName

    + +
      +
    • + +
      +
      +

      Set a custom baseName for metrics.

      +
      +
      +

      Parameters

      +
        +
      • +
        baseName: string
        +
        +

        the new baseName.

        +
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    monitoredHttpServerUris

    -
    monitoredHttpServerUris: Match
    - -
    -
    -

    Add an monitored http server uri.

    -
    -
    -
    param
    -

    the handler match

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setConfigPath

    + +
      +
    • + +
      +
      +

      Set the path for a config file that contains options in JSON format, to be used to create a new options object. + The file will be looked for on the file system first and then on the classpath if it's not found.

      +
      +
      +

      Parameters

      +
        +
      • +
        configPath: string
        +
        +

        the file name

        +
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    registryName

    -
    registryName: string
    - -
    -
    -

    Set the name used for registering the metrics in the Dropwizard shared registry.

    -
    -
    -
    param
    -

    the name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setEnabled

    + + +
    +
    + +

    setJmxDomain

    + +
      +
    • + +
      +
      +

      Set the JMX domain to use when JMX metrics are enabled.

      +
      +
      +

      Parameters

      +
        +
      • +
        jmxDomain: string
        +
        +

        the JMX domain

        +
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setJmxEnabled

    + +
      +
    • + +
      +
      +

      Set whether JMX will be enabled on the Vert.x instance.

      +
      +
      +

      Parameters

      +
        +
      • +
        jmxEnabled: boolean
        +
        +

        true if JMX enabled, or false if not.

        +
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRegistryName

    + +
      +
    • + +
      +
      +

      Set the name used for registering the metrics in the Dropwizard shared registry.

      +
      +
      +

      Parameters

      +
        +
      • +
        registryName: string
        +
        +

        the name

        +
        +
        • +
      +

      Returns DropwizardMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -331,35 +710,71 @@

    registryName

  • DropwizardMetricsOptions
    • diff --git a/docs/@vertx/dropwizard-metrics/classes/match.html b/docs/@vertx/dropwizard-metrics/classes/match.html index 900e967f7..403292913 100644 --- a/docs/@vertx/dropwizard-metrics/classes/match.html +++ b/docs/@vertx/dropwizard-metrics/classes/match.html @@ -77,87 +77,228 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    alias

    -
    alias: string
    - -
    -
    -

    Set the alias the human readable name that will be used as a part of - registry entry name when the value matches.

    -
    -
    -
    param
    -

    the matcher alias

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Match

      +
      • +
    • + +

      Parameters

      + +

      Returns Match

      +
      • +
    -
    - -

    type

    -
    type: MatchType
    - -
    -
    -

    Set the type of matching to apply.

    -
    -
    -
    param
    -

    the matcher type

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAlias

    +
      +
    • getAlias(): string
      • +
    +
      +
    • + +
      +
      +

      Set the alias the human readable name that will be used as a part of + registry entry name when the value matches.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    value

    -
    value: string
    - -
    -
    -

    Set the matched value.

    -
    -
    -
    param
    -

    the value to match

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getType

    +
      +
    • getType(): MatchType
      • +
    +
      +
    • + +
      +
      +

      Set the type of matching to apply.

      +
      +
      +

      Returns MatchType

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getValue

    +
      +
    • getValue(): string
      • +
    +
      +
    • + +
      +
      +

      Set the matched value.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAlias

    +
      +
    • setAlias(alias: string): Match
      • +
    +
      +
    • + +
      +
      +

      Set the alias the human readable name that will be used as a part of + registry entry name when the value matches.

      +
      +
      +

      Parameters

      +
        +
      • +
        alias: string
        +
        +

        the matcher alias

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setType

    +
      +
    • setType(type: MatchType): Match
      • +
    +
      +
    • + +
      +
      +

      Set the type of matching to apply.

      +
      +
      +

      Parameters

      +
        +
      • +
        type: MatchType
        +
        +

        the matcher type

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setValue

    +
      +
    • setValue(value: string): Match
      • +
    +
      +
    • + +
      +
      +

      Set the matched value.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: string
        +
        +

        the value to match

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -179,14 +320,26 @@

    value

  • Match
    • diff --git a/docs/@vertx/dropwizard-metrics/classes/metricsservice.html b/docs/@vertx/dropwizard-metrics/classes/metricsservice.html index cd7e4cdf3..3382ffd4d 100644 --- a/docs/@vertx/dropwizard-metrics/classes/metricsservice.html +++ b/docs/@vertx/dropwizard-metrics/classes/metricsservice.html @@ -100,7 +100,7 @@

    getBaseName

  • @@ -130,12 +130,12 @@

    getMetricsSnapshot

  • -

    Will return the metrics that correspond with the {@code measured} object, null if no metrics is available.

    +

    Will return the metrics that correspond with the {@code measured} object, null if no metrics is available.

    Note: in the case of scaled servers, the JsonObject returns an aggregation of the metrics as the dropwizard backend reports to a single server.

    @@ -149,16 +149,21 @@
    measured: Measured

    Returns object

    the map of metrics where the key is the name of the metric (excluding the base name unless for the Vert.x object) and the value is the json data representing that metric

    +
      +
    • +
      [key: string]: any
      +
      • +
  • -

    Will return the metrics that begins with the {@code baseName}, null if no metrics is available.

    +

    Will return the metrics that begins with the {@code baseName}, null if no metrics is available.

    Note: in the case of scaled servers, the JsonObject returns an aggregation of the metrics as the dropwizard backend reports to a single server.

    @@ -172,6 +177,11 @@
    baseName: string

    Returns object

    the map of metrics where the key is the name of the metric and the value is the json data representing that metric

    +
      +
    • +
      [key: string]: any
      +
      • +
    • @@ -185,7 +195,7 @@

    metricsNames

  • @@ -205,12 +215,12 @@

    Static create

  • -

    Creates a metric service for a given {@link io.vertx.core.Vertx} instance.

    +

    Creates a metric service for a given {@link io.vertx.core.Vertx} instance.

    Parameters

    diff --git a/docs/@vertx/hawkular-metrics/assets/js/search.js b/docs/@vertx/hawkular-metrics/assets/js/search.js deleted file mode 100644 index 9f1849e8e..000000000 --- a/docs/@vertx/hawkular-metrics/assets/js/search.js +++ /dev/null @@ -1,3 +0,0 @@ -var typedoc = typedoc || {}; - typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property"},"rows":[{"id":0,"kind":4,"name":"MetricsType","url":"enums/metricstype.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"NET_SERVER","url":"enums/metricstype.html#net_server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":2,"kind":16,"name":"NET_CLIENT","url":"enums/metricstype.html#net_client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":3,"kind":16,"name":"HTTP_SERVER","url":"enums/metricstype.html#http_server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":4,"kind":16,"name":"HTTP_CLIENT","url":"enums/metricstype.html#http_client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":5,"kind":16,"name":"DATAGRAM_SOCKET","url":"enums/metricstype.html#datagram_socket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":6,"kind":16,"name":"EVENT_BUS","url":"enums/metricstype.html#event_bus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":7,"kind":16,"name":"NAMED_POOLS","url":"enums/metricstype.html#named_pools","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":8,"kind":16,"name":"VERTICLES","url":"enums/metricstype.html#verticles","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsType"},{"id":9,"kind":128,"name":"AuthenticationOptions","url":"classes/authenticationoptions.html","classes":"tsd-kind-class"},{"id":10,"kind":1024,"name":"enabled","url":"classes/authenticationoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AuthenticationOptions"},{"id":11,"kind":1024,"name":"id","url":"classes/authenticationoptions.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AuthenticationOptions"},{"id":12,"kind":1024,"name":"secret","url":"classes/authenticationoptions.html#secret","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AuthenticationOptions"},{"id":13,"kind":128,"name":"MetricTagsMatch","url":"classes/metrictagsmatch.html","classes":"tsd-kind-class"},{"id":14,"kind":1024,"name":"tags","url":"classes/metrictagsmatch.html#tags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MetricTagsMatch"},{"id":15,"kind":1024,"name":"type","url":"classes/metrictagsmatch.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MetricTagsMatch"},{"id":16,"kind":1024,"name":"value","url":"classes/metrictagsmatch.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MetricTagsMatch"},{"id":17,"kind":128,"name":"VertxHawkularOptions","url":"classes/vertxhawkularoptions.html","classes":"tsd-kind-class"},{"id":18,"kind":1024,"name":"authenticationOptions","url":"classes/vertxhawkularoptions.html#authenticationoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":19,"kind":1024,"name":"batchDelay","url":"classes/vertxhawkularoptions.html#batchdelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":20,"kind":1024,"name":"batchSize","url":"classes/vertxhawkularoptions.html#batchsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":21,"kind":1024,"name":"disabledMetricsTypes","url":"classes/vertxhawkularoptions.html#disabledmetricstypes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":22,"kind":1024,"name":"enabled","url":"classes/vertxhawkularoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":23,"kind":1024,"name":"host","url":"classes/vertxhawkularoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":24,"kind":1024,"name":"httpHeaders","url":"classes/vertxhawkularoptions.html#httpheaders","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":25,"kind":1024,"name":"httpOptions","url":"classes/vertxhawkularoptions.html#httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":26,"kind":1024,"name":"metricTagsMatches","url":"classes/vertxhawkularoptions.html#metrictagsmatches","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":27,"kind":1024,"name":"metricsBridgeAddress","url":"classes/vertxhawkularoptions.html#metricsbridgeaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":28,"kind":1024,"name":"metricsBridgeEnabled","url":"classes/vertxhawkularoptions.html#metricsbridgeenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":29,"kind":1024,"name":"metricsServiceUri","url":"classes/vertxhawkularoptions.html#metricsserviceuri","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":30,"kind":1024,"name":"port","url":"classes/vertxhawkularoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":31,"kind":1024,"name":"prefix","url":"classes/vertxhawkularoptions.html#prefix","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":32,"kind":1024,"name":"schedule","url":"classes/vertxhawkularoptions.html#schedule","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":33,"kind":1024,"name":"sendTenantHeader","url":"classes/vertxhawkularoptions.html#sendtenantheader","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":34,"kind":1024,"name":"taggedMetricsCacheSize","url":"classes/vertxhawkularoptions.html#taggedmetricscachesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":35,"kind":1024,"name":"tags","url":"classes/vertxhawkularoptions.html#tags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"},{"id":36,"kind":1024,"name":"tenant","url":"classes/vertxhawkularoptions.html#tenant","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxHawkularOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/hawkular-metrics/classes/vertxhawkularoptions.html b/docs/@vertx/hawkular-metrics/classes/vertxhawkularoptions.html deleted file mode 100644 index 376f28de0..000000000 --- a/docs/@vertx/hawkular-metrics/classes/vertxhawkularoptions.html +++ /dev/null @@ -1,588 +0,0 @@ - - - - - - VertxHawkularOptions | @vertx/hawkular-metrics - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Class VertxHawkularOptions

    -
    -
    -
    -
    -
    -
    -
    -

    Hierarchy

    -
      -
    • - VertxHawkularOptions -
      • -
    -
    -
    -

    Index

    -
    -
    -
    -

    Properties

    - -
    -
    -
    -
    -
    -

    Properties

    -
    - -

    authenticationOptions

    -
    authenticationOptions: AuthenticationOptions
    - -
    -
    -

    Set the options for authentication.

    -
    -
    -
    -
    - -

    batchDelay

    -
    batchDelay: number
    - -
    -
    -

    Set the maximum delay between two consecutive batches (in seconds). To reduce the number of HTTP exchanges, metric - data is sent to the Hawkular server in batches. A batch is sent as soon as the number of metrics collected reaches - the configured {@code batchSize}, or after the {@code batchDelay} expires. Defaults to {@code 1} second.

    -
    -
    -
    -
    - -

    batchSize

    -
    batchSize: number
    - -
    -
    -

    Set the maximum number of metrics in a batch. To reduce the number of HTTP exchanges, metric data is sent to the - Hawkular server in batches. A batch is sent as soon as the number of metrics collected reaches the configured - {@code batchSize}, or after the {@code batchDelay} expires. Defaults to {@code 50}.

    -
    -
    -
    -
    - -

    disabledMetricsTypes

    -
    disabledMetricsTypes: MetricsType
    - -
    -
    -

    Sets metrics types that are disabled.

    -
    -
    -
    param
    -

    to specify the set of metrics types to be disabled.

    -
    -
    -
    -
    -
    - -

    enabled

    -
    enabled: boolean
    - -
    -
    -

    Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

    -
    -
    -
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the Hawkular Metrics service host. Defaults to {@code localhost}.

    -
    -
    -
    -
    - -

    httpHeaders

    -
    httpHeaders: object
    - -
    -
    -

    Set specific headers to include in HTTP requests.

    -
    -
    -
    -
    - -

    httpOptions

    -
    httpOptions: HttpClientOptions
    - -
    -
    -

    Set the configuration of the Hawkular Metrics HTTP client.

    -
    -
    -
    -
    - -

    metricTagsMatches

    -
    metricTagsMatches: MetricTagsMatch
    - -
    -
    -

    Sets a list of MetricTagsMatch.

    -
    -
    -
    param
    -

    a list of MetricTagsMatch

    -
    -
    -
    -
    -
    - -

    metricsBridgeAddress

    -
    metricsBridgeAddress: string
    - -
    -
    -

    Sets the metric bridge address on which the application is sending the custom metrics. Application can send - metrics to this event bus address. The message is a JSON object specifying at least the {@code id} and - {@code value} fields. -

    - Don't forget to also enable the bridge with {@code metricsBridgeEnabled}.

    -
    -
    -
    param
    -

    the address

    -
    -
    returns
    -

    the current VertxHawkularOptions instance

    -
    -
    -
    -
    -
    - -

    metricsBridgeEnabled

    -
    metricsBridgeEnabled: boolean
    - -
    -
    -

    Sets whether or not the metrics bridge should be enabled. The metrics bridge is disabled by default.

    -
    -
    -
    param
    -

    to enable the bridge, {@code false} to disable it.

    -
    -
    returns
    -

    the current VertxHawkularOptions instance

    -
    -
    -
    -
    -
    - -

    metricsServiceUri

    -
    metricsServiceUri: string
    - -
    -
    -

    Set the Hawkular Metrics service URI. Defaults to {@code /hawkular/metrics}. This can be useful if you host the - Hawkular server behind a proxy and manipulate the default service URI.

    -
    -
    -
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the Hawkular Metrics service port. Defaults to {@code 8080}.

    -
    -
    -
    -
    - -

    prefix

    -
    prefix: string
    - -
    -
    -

    Set the metric name prefix. Metric names are not prefixed by default. Prefixing metric names is required to - distinguish data sent by different Vert.x instances.

    -
    -
    -
    -
    - -

    schedule

    -
    schedule: number
    - -
    -
    -

    Set the metric collection interval (in seconds). Defaults to {@code 1}.

    -
    -
    -
    -
    - -

    sendTenantHeader

    -
    sendTenantHeader: boolean
    - -
    -
    -

    Set whether Hawkular tenant header should be sent. Defaults to {@code true}. - Must be set to {@code false} when working with pre-Alpha13 Hawkular servers.

    -
    -
    -
    -
    - -

    taggedMetricsCacheSize

    -
    taggedMetricsCacheSize: number
    - -
    -
    -

    Set the number of metric names to cache in order to avoid repeated tagging requests.

    -
    -
    -
    -
    - -

    tags

    -
    tags: object
    - -
    -
    -

    Set tags applied to all metrics.

    -
    -
    -
    -
    - -

    tenant

    -
    tenant: string
    - -
    -
    -

    Set the Hawkular tenant. Defaults to {@code default}.

    -
    -
    -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Module
      • -
    • Object literal
      • -
    • Variable
      • -
    • Function
      • -
    • Function with type parameter
      • -
    • Index signature
      • -
    • Type alias
      • -
    -
      -
    • Enumeration
      • -
    • Enumeration member
      • -
    • Property
      • -
    • Method
      • -
    -
      -
    • Interface
      • -
    • Interface with type parameter
      • -
    • Constructor
      • -
    • Property
      • -
    • Method
      • -
    • Index signature
      • -
    -
      -
    • Class
      • -
    • Class with type parameter
      • -
    • Constructor
      • -
    • Property
      • -
    • Method
      • -
    • Accessor
      • -
    • Index signature
      • -
    -
      -
    • Inherited constructor
      • -
    • Inherited property
      • -
    • Inherited method
      • -
    • Inherited accessor
      • -
    -
      -
    • Protected property
      • -
    • Protected method
      • -
    • Protected accessor
      • -
    -
      -
    • Private property
      • -
    • Private method
      • -
    • Private accessor
      • -
    -
      -
    • Static property
      • -
    • Static method
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - - \ No newline at end of file diff --git a/docs/@vertx/health-check/assets/js/search.js b/docs/@vertx/health-check/assets/js/search.js index e9e1600d1..dea5de938 100644 --- a/docs/@vertx/health-check/assets/js/search.js +++ b/docs/@vertx/health-check/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"Status","url":"classes/status.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"data","url":"classes/status.html#data","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Status"},{"id":2,"kind":1024,"name":"ok","url":"classes/status.html#ok","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Status"},{"id":3,"kind":1024,"name":"procedureInError","url":"classes/status.html#procedureinerror","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Status"},{"id":4,"kind":128,"name":"HealthCheckHandler","url":"classes/healthcheckhandler.html","classes":"tsd-kind-class"},{"id":5,"kind":2048,"name":"handle","url":"classes/healthcheckhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthCheckHandler"},{"id":6,"kind":2048,"name":"create","url":"classes/healthcheckhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HealthCheckHandler"},{"id":7,"kind":2048,"name":"createWithHealthChecks","url":"classes/healthcheckhandler.html#createwithhealthchecks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HealthCheckHandler"},{"id":8,"kind":2048,"name":"register","url":"classes/healthcheckhandler.html#register","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthCheckHandler"},{"id":9,"kind":2048,"name":"unregister","url":"classes/healthcheckhandler.html#unregister","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthCheckHandler"},{"id":10,"kind":128,"name":"HealthChecks","url":"classes/healthchecks.html","classes":"tsd-kind-class"},{"id":11,"kind":2048,"name":"create","url":"classes/healthchecks.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HealthChecks"},{"id":12,"kind":2048,"name":"register","url":"classes/healthchecks.html#register","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthChecks"},{"id":13,"kind":2048,"name":"unregister","url":"classes/healthchecks.html#unregister","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthChecks"},{"id":14,"kind":2048,"name":"invoke","url":"classes/healthchecks.html#invoke","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthChecks"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"Status","url":"classes/status.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/status.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Status"},{"id":2,"kind":2048,"name":"getData","url":"classes/status.html#getdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Status"},{"id":3,"kind":2048,"name":"setData","url":"classes/status.html#setdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Status"},{"id":4,"kind":2048,"name":"isOk","url":"classes/status.html#isok","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Status"},{"id":5,"kind":2048,"name":"setOk","url":"classes/status.html#setok","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Status"},{"id":6,"kind":2048,"name":"isProcedureInError","url":"classes/status.html#isprocedureinerror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Status"},{"id":7,"kind":2048,"name":"setProcedureInError","url":"classes/status.html#setprocedureinerror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Status"},{"id":8,"kind":128,"name":"HealthCheckHandler","url":"classes/healthcheckhandler.html","classes":"tsd-kind-class"},{"id":9,"kind":2048,"name":"handle","url":"classes/healthcheckhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthCheckHandler"},{"id":10,"kind":2048,"name":"create","url":"classes/healthcheckhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HealthCheckHandler"},{"id":11,"kind":2048,"name":"createWithHealthChecks","url":"classes/healthcheckhandler.html#createwithhealthchecks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HealthCheckHandler"},{"id":12,"kind":2048,"name":"register","url":"classes/healthcheckhandler.html#register","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthCheckHandler"},{"id":13,"kind":2048,"name":"unregister","url":"classes/healthcheckhandler.html#unregister","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthCheckHandler"},{"id":14,"kind":128,"name":"HealthChecks","url":"classes/healthchecks.html","classes":"tsd-kind-class"},{"id":15,"kind":2048,"name":"create","url":"classes/healthchecks.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HealthChecks"},{"id":16,"kind":2048,"name":"register","url":"classes/healthchecks.html#register","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthChecks"},{"id":17,"kind":2048,"name":"unregister","url":"classes/healthchecks.html#unregister","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthChecks"},{"id":18,"kind":2048,"name":"invoke","url":"classes/healthchecks.html#invoke","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HealthChecks"}]}; \ No newline at end of file diff --git a/docs/@vertx/health-check/classes/healthcheckhandler.html b/docs/@vertx/health-check/classes/healthcheckhandler.html index 56b0491a6..4560454ae 100644 --- a/docs/@vertx/health-check/classes/healthcheckhandler.html +++ b/docs/@vertx/health-check/classes/healthcheckhandler.html @@ -72,6 +72,12 @@

    Hierarchy

    • +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -101,7 +107,7 @@

    handle

  • Parameters

    @@ -125,12 +131,12 @@

    register

  • -

    Registers a health check procedure. +

    Registers a health check procedure.

    The procedure is a {@link Handler} taking a {@link Future} of Status as parameter. Procedures are asynchronous, and must complete or fail the given {@link Future}. If the future object is @@ -157,17 +163,20 @@

    procedure: function
    • -

    Properties

    -
    - -

    data

    -
    data: object
    - -
    -
    -

    Sets the metadata.

    -
    -
    -
    param
    -

    the data

    -
    -
    returns
    -

    the current status

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Status

      +
      • +
    • + +

      Parameters

      + +

      Returns Status

      +
      • +
    -
    - -

    ok

    -
    ok: boolean
    - -
    -
    -

    Sets whether or not the current status is positive (UP) or negative (DOWN).

    -
    -
    -
    param
    -

    for UP, {@code false} for DOWN

    -
    -
    returns
    -

    the current status

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getData

    +
      +
    • getData(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the metadata.

      +
      +
      +

      Returns object

      +

      the current status

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    procedureInError

    -
    procedureInError: boolean
    - -
    -
    -

    Sets whether or not the procedure attached to this status has failed (timeout, error...).

    -
    -
    -
    param
    -

    if the procedure has not been completed correctly.

    -
    -
    returns
    -

    the current status

    -
    -
    -
    +
    + +

    isOk

    +
      +
    • isOk(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the current status is positive (UP) or negative (DOWN).

      +
      +
      +

      Returns boolean

      +

      the current status

      +
      • +
    +
    +
    + +

    isProcedureInError

    +
      +
    • isProcedureInError(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the procedure attached to this status has failed (timeout, error...).

      +
      +
      +

      Returns boolean

      +

      the current status

      +
      • +
    +
    +
    + +

    setData

    +
      +
    • setData(data: object): Status
      • +
    +
      +
    • + +
      +
      +

      Sets the metadata.

      +
      +
      +

      Parameters

      +
        +
      • +
        data: object
        +
        +

        the data

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns Status

      +

      the current status

      +
      • +
    +
    +
    + +

    setOk

    +
      +
    • setOk(ok: boolean): Status
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the current status is positive (UP) or negative (DOWN).

      +
      +
      +

      Parameters

      +
        +
      • +
        ok: boolean
        +
        +

        for UP, {@code false} for DOWN

        +
        +
        • +
      +

      Returns Status

      +

      the current status

      +
      • +
    +
    +
    + +

    setProcedureInError

    +
      +
    • setProcedureInError(procedureInError: boolean): Status
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the procedure attached to this status has failed (timeout, error...).

      +
      +
      +

      Parameters

      +
        +
      • +
        procedureInError: boolean
        +
        +

        if the procedure has not been completed correctly.

        +
        +
        • +
      +

      Returns Status

      +

      the current status

      +
      • +
    @@ -181,14 +331,26 @@

    procedureInError

  • Status
    • diff --git a/docs/@vertx/hawkular-metrics/assets/css/main.css b/docs/@vertx/jdbc/assets/css/main.css similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/css/main.css rename to docs/@vertx/jdbc/assets/css/main.css diff --git a/docs/@vertx/hawkular-metrics/assets/css/main.css.map b/docs/@vertx/jdbc/assets/css/main.css.map similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/css/main.css.map rename to docs/@vertx/jdbc/assets/css/main.css.map diff --git a/docs/@vertx/hawkular-metrics/assets/images/icons.png b/docs/@vertx/jdbc/assets/images/icons.png similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/images/icons.png rename to docs/@vertx/jdbc/assets/images/icons.png diff --git a/docs/@vertx/hawkular-metrics/assets/images/icons@2x.png b/docs/@vertx/jdbc/assets/images/icons@2x.png similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/images/icons@2x.png rename to docs/@vertx/jdbc/assets/images/icons@2x.png diff --git a/docs/@vertx/hawkular-metrics/assets/images/widgets.png b/docs/@vertx/jdbc/assets/images/widgets.png similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/images/widgets.png rename to docs/@vertx/jdbc/assets/images/widgets.png diff --git a/docs/@vertx/hawkular-metrics/assets/images/widgets@2x.png b/docs/@vertx/jdbc/assets/images/widgets@2x.png similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/images/widgets@2x.png rename to docs/@vertx/jdbc/assets/images/widgets@2x.png diff --git a/docs/@vertx/hawkular-metrics/assets/js/main.js b/docs/@vertx/jdbc/assets/js/main.js similarity index 100% rename from docs/@vertx/hawkular-metrics/assets/js/main.js rename to docs/@vertx/jdbc/assets/js/main.js diff --git a/docs/@vertx/jdbc-client/assets/js/search.js b/docs/@vertx/jdbc/assets/js/search.js similarity index 100% rename from docs/@vertx/jdbc-client/assets/js/search.js rename to docs/@vertx/jdbc/assets/js/search.js diff --git a/docs/@vertx/jdbc-client/classes/jdbcclient.html b/docs/@vertx/jdbc/classes/jdbcclient.html similarity index 78% rename from docs/@vertx/jdbc-client/classes/jdbcclient.html rename to docs/@vertx/jdbc/classes/jdbcclient.html index c5a1f98b2..5a17cca55 100644 --- a/docs/@vertx/jdbc-client/classes/jdbcclient.html +++ b/docs/@vertx/jdbc/classes/jdbcclient.html @@ -3,7 +3,7 @@ - JDBCClient | @vertx/jdbc-client + JDBCClient | @vertx/jdbc @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/jdbc-client + @vertx/jdbc
    @@ -68,7 +68,12 @@

    Class JDBCClient

    Hierarchy

    • - JDBCClient + any +
        +
      • + JDBCClient +
        • +
    @@ -100,7 +105,7 @@

    querySingle

  • Parameters

    @@ -113,17 +118,20 @@
    handler: function

    Returns JDBCClient

    diff --git a/docs/@vertx/jdbc-client/globals.html b/docs/@vertx/jdbc/globals.html similarity index 98% rename from docs/@vertx/jdbc-client/globals.html rename to docs/@vertx/jdbc/globals.html index aee453295..41fa6a224 100644 --- a/docs/@vertx/jdbc-client/globals.html +++ b/docs/@vertx/jdbc/globals.html @@ -3,7 +3,7 @@ - @vertx/jdbc-client + @vertx/jdbc @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/jdbc-client + @vertx/jdbc
    @@ -54,7 +54,7 @@ Globals -

    @vertx/jdbc-client

    +

    @vertx/jdbc

    diff --git a/docs/@vertx/jdbc-client/index.html b/docs/@vertx/jdbc/index.html similarity index 98% rename from docs/@vertx/jdbc-client/index.html rename to docs/@vertx/jdbc/index.html index 7035aeb7f..754717ddf 100644 --- a/docs/@vertx/jdbc-client/index.html +++ b/docs/@vertx/jdbc/index.html @@ -3,7 +3,7 @@ - @vertx/jdbc-client + @vertx/jdbc @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/jdbc-client + @vertx/jdbc
    @@ -54,7 +54,7 @@ Globals -

    @vertx/jdbc-client

    +

    @vertx/jdbc

    diff --git a/docs/@vertx/jdbc-client/assets/css/main.css b/docs/@vertx/jwt/assets/css/main.css similarity index 100% rename from docs/@vertx/jdbc-client/assets/css/main.css rename to docs/@vertx/jwt/assets/css/main.css diff --git a/docs/@vertx/jdbc-client/assets/css/main.css.map b/docs/@vertx/jwt/assets/css/main.css.map similarity index 100% rename from docs/@vertx/jdbc-client/assets/css/main.css.map rename to docs/@vertx/jwt/assets/css/main.css.map diff --git a/docs/@vertx/jdbc-client/assets/images/icons.png b/docs/@vertx/jwt/assets/images/icons.png similarity index 100% rename from docs/@vertx/jdbc-client/assets/images/icons.png rename to docs/@vertx/jwt/assets/images/icons.png diff --git a/docs/@vertx/jdbc-client/assets/images/icons@2x.png b/docs/@vertx/jwt/assets/images/icons@2x.png similarity index 100% rename from docs/@vertx/jdbc-client/assets/images/icons@2x.png rename to docs/@vertx/jwt/assets/images/icons@2x.png diff --git a/docs/@vertx/jdbc-client/assets/images/widgets.png b/docs/@vertx/jwt/assets/images/widgets.png similarity index 100% rename from docs/@vertx/jdbc-client/assets/images/widgets.png rename to docs/@vertx/jwt/assets/images/widgets.png diff --git a/docs/@vertx/jdbc-client/assets/images/widgets@2x.png b/docs/@vertx/jwt/assets/images/widgets@2x.png similarity index 100% rename from docs/@vertx/jdbc-client/assets/images/widgets@2x.png rename to docs/@vertx/jwt/assets/images/widgets@2x.png diff --git a/docs/@vertx/jdbc-client/assets/js/main.js b/docs/@vertx/jwt/assets/js/main.js similarity index 100% rename from docs/@vertx/jdbc-client/assets/js/main.js rename to docs/@vertx/jwt/assets/js/main.js diff --git a/docs/@vertx/jwt/assets/js/search.js b/docs/@vertx/jwt/assets/js/search.js new file mode 100644 index 000000000..6dfdea906 --- /dev/null +++ b/docs/@vertx/jwt/assets/js/search.js @@ -0,0 +1,3 @@ +var typedoc = typedoc || {}; + typedoc.search = typedoc.search || {}; + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"JWTOptions","url":"classes/jwtoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/jwtoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"JWTOptions"},{"id":2,"kind":2048,"name":"getAlgorithm","url":"classes/jwtoptions.html#getalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":3,"kind":2048,"name":"setAlgorithm","url":"classes/jwtoptions.html#setalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":4,"kind":2048,"name":"getAudience","url":"classes/jwtoptions.html#getaudience","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":5,"kind":2048,"name":"setAudience","url":"classes/jwtoptions.html#setaudience","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":6,"kind":2048,"name":"audiences","url":"classes/jwtoptions.html#audiences","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":7,"kind":2048,"name":"addAudience","url":"classes/jwtoptions.html#addaudience","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":8,"kind":2048,"name":"expiresInMinutes","url":"classes/jwtoptions.html#expiresinminutes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":9,"kind":2048,"name":"setExpiresInMinutes","url":"classes/jwtoptions.html#setexpiresinminutes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":10,"kind":2048,"name":"getExpiresInSeconds","url":"classes/jwtoptions.html#getexpiresinseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":11,"kind":2048,"name":"setExpiresInSeconds","url":"classes/jwtoptions.html#setexpiresinseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":12,"kind":2048,"name":"getHeader","url":"classes/jwtoptions.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":13,"kind":2048,"name":"setHeader","url":"classes/jwtoptions.html#setheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":14,"kind":2048,"name":"isIgnoreExpiration","url":"classes/jwtoptions.html#isignoreexpiration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":15,"kind":2048,"name":"setIgnoreExpiration","url":"classes/jwtoptions.html#setignoreexpiration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":16,"kind":2048,"name":"getIssuer","url":"classes/jwtoptions.html#getissuer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":17,"kind":2048,"name":"setIssuer","url":"classes/jwtoptions.html#setissuer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":18,"kind":2048,"name":"getLeeway","url":"classes/jwtoptions.html#getleeway","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":19,"kind":2048,"name":"setLeeway","url":"classes/jwtoptions.html#setleeway","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":20,"kind":2048,"name":"isNoTimestamp","url":"classes/jwtoptions.html#isnotimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":21,"kind":2048,"name":"setNoTimestamp","url":"classes/jwtoptions.html#setnotimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":22,"kind":2048,"name":"getPermissions","url":"classes/jwtoptions.html#getpermissions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":23,"kind":2048,"name":"setPermissions","url":"classes/jwtoptions.html#setpermissions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":24,"kind":2048,"name":"addPermission","url":"classes/jwtoptions.html#addpermission","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":25,"kind":2048,"name":"getSubject","url":"classes/jwtoptions.html#getsubject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"},{"id":26,"kind":2048,"name":"setSubject","url":"classes/jwtoptions.html#setsubject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JWTOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/jwt/classes/jwtoptions.html b/docs/@vertx/jwt/classes/jwtoptions.html new file mode 100644 index 000000000..10f99aee1 --- /dev/null +++ b/docs/@vertx/jwt/classes/jwtoptions.html @@ -0,0 +1,862 @@ + + + + + + JWTOptions | @vertx/jwt + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class JWTOptions

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + JWTOptions +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns JWTOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns JWTOptions

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addAudience

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        audiences: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    addPermission

    +
      +
    • addPermission(permissions: string): JWTOptions
      • +
    +
      +
    • + +
      +
      +

      The permissions of this token.

      +
      +
      +

      Parameters

      +
        +
      • +
        permissions: string
        +
        +

        the permissions for this token that will be used for AuthZ

        +
        +
        • +
      +

      Returns JWTOptions

      +

      fluent API

      +
      • +
    +
    +
    + +

    audiences

    +
      +
    • audiences(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    expiresInMinutes

    +
      +
    • expiresInMinutes(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getAlgorithm

    +
      +
    • getAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getAudience

    +
      +
    • getAudience(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getExpiresInSeconds

    +
      +
    • getExpiresInSeconds(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getHeader

    +
      +
    • getHeader(): object
      • +
    +
      +
    • + +

      Returns object

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    getIssuer

    +
      +
    • getIssuer(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getLeeway

    +
      +
    • getLeeway(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getPermissions

    +
      +
    • getPermissions(): string
      • +
    +
      +
    • + +
      +
      +

      The permissions of this token.

      +
      +
      +

      Returns string

      +

      fluent API

      +
      • +
    +
    +
    + +

    getSubject

    +
      +
    • getSubject(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    isIgnoreExpiration

    +
      +
    • isIgnoreExpiration(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isNoTimestamp

    +
      +
    • isNoTimestamp(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAlgorithm

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        algorithm: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setAudience

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        audience: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setExpiresInMinutes

    +
      +
    • setExpiresInMinutes(expiresInMinutes: number): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        expiresInMinutes: number
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setExpiresInSeconds

    +
      +
    • setExpiresInSeconds(expiresInSeconds: number): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        expiresInSeconds: number
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setHeader

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        header: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setIgnoreExpiration

    +
      +
    • setIgnoreExpiration(ignoreExpiration: boolean): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        ignoreExpiration: boolean
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setIssuer

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        issuer: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setLeeway

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        leeway: number
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setNoTimestamp

    +
      +
    • setNoTimestamp(noTimestamp: boolean): JWTOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        noTimestamp: boolean
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    + +

    setPermissions

    +
      +
    • setPermissions(permissions: string): JWTOptions
      • +
    +
      +
    • + +
      +
      +

      The permissions of this token.

      +
      +
      +

      Parameters

      +
        +
      • +
        permissions: string
        +
        +

        the permissions for this token that will be used for AuthZ

        +
        +
        • +
      +

      Returns JWTOptions

      +

      fluent API

      +
      • +
    +
    +
    + +

    setSubject

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        subject: string
        +
        • +
      +

      Returns JWTOptions

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/camel-bridge/globals.html b/docs/@vertx/jwt/globals.html similarity index 91% rename from docs/@vertx/camel-bridge/globals.html rename to docs/@vertx/jwt/globals.html index 9c9a0db3f..d347607cb 100644 --- a/docs/@vertx/camel-bridge/globals.html +++ b/docs/@vertx/jwt/globals.html @@ -3,7 +3,7 @@ - @vertx/camel-bridge + @vertx/jwt @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/camel-bridge + @vertx/jwt
    @@ -54,13 +54,26 @@ Globals -

    @vertx/camel-bridge

    +

    @vertx/jwt

    +
    +

    Index

    +
    +
    +
    +

    Classes

    + +
    +
    +
    +
    diff --git a/docs/@vertx/jwt/index.html b/docs/@vertx/jwt/index.html new file mode 100644 index 000000000..b7f1f3f9d --- /dev/null +++ b/docs/@vertx/jwt/index.html @@ -0,0 +1,184 @@ + + + + + + @vertx/jwt + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    @vertx/jwt

    +
    +
    +
    +
    +
    +
    +
    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/jwt');
+// Base ENUMs
+const Enums = require('@vertx/jwt/enums');
+// DataObject's
+const Options = require('@vertx/jwt/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + + +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/kafka-client/assets/js/search.js b/docs/@vertx/kafka-client/assets/js/search.js index b17c1e0c0..6fc23388f 100644 --- a/docs/@vertx/kafka-client/assets/js/search.js +++ b/docs/@vertx/kafka-client/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"Node","url":"classes/node.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"hasRack","url":"classes/node.html#hasrack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":2,"kind":1024,"name":"host","url":"classes/node.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":3,"kind":1024,"name":"id","url":"classes/node.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":4,"kind":1024,"name":"idString","url":"classes/node.html#idstring","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":5,"kind":1024,"name":"isEmpty","url":"classes/node.html#isempty","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":6,"kind":1024,"name":"port","url":"classes/node.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":7,"kind":1024,"name":"rack","url":"classes/node.html#rack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Node"},{"id":8,"kind":128,"name":"OffsetAndMetadata","url":"classes/offsetandmetadata.html","classes":"tsd-kind-class"},{"id":9,"kind":1024,"name":"metadata","url":"classes/offsetandmetadata.html#metadata","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":10,"kind":1024,"name":"offset","url":"classes/offsetandmetadata.html#offset","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":11,"kind":128,"name":"OffsetAndTimestamp","url":"classes/offsetandtimestamp.html","classes":"tsd-kind-class"},{"id":12,"kind":1024,"name":"offset","url":"classes/offsetandtimestamp.html#offset","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":13,"kind":1024,"name":"timestamp","url":"classes/offsetandtimestamp.html#timestamp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":14,"kind":128,"name":"PartitionInfo","url":"classes/partitioninfo.html","classes":"tsd-kind-class"},{"id":15,"kind":1024,"name":"inSyncReplicas","url":"classes/partitioninfo.html#insyncreplicas","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PartitionInfo"},{"id":16,"kind":1024,"name":"leader","url":"classes/partitioninfo.html#leader","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PartitionInfo"},{"id":17,"kind":1024,"name":"partition","url":"classes/partitioninfo.html#partition","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PartitionInfo"},{"id":18,"kind":1024,"name":"replicas","url":"classes/partitioninfo.html#replicas","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PartitionInfo"},{"id":19,"kind":1024,"name":"topic","url":"classes/partitioninfo.html#topic","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PartitionInfo"},{"id":20,"kind":128,"name":"RecordMetadata","url":"classes/recordmetadata.html","classes":"tsd-kind-class"},{"id":21,"kind":1024,"name":"checksum","url":"classes/recordmetadata.html#checksum","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RecordMetadata"},{"id":22,"kind":1024,"name":"offset","url":"classes/recordmetadata.html#offset","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RecordMetadata"},{"id":23,"kind":1024,"name":"partition","url":"classes/recordmetadata.html#partition","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RecordMetadata"},{"id":24,"kind":1024,"name":"timestamp","url":"classes/recordmetadata.html#timestamp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RecordMetadata"},{"id":25,"kind":1024,"name":"topic","url":"classes/recordmetadata.html#topic","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RecordMetadata"},{"id":26,"kind":128,"name":"TopicPartition","url":"classes/topicpartition.html","classes":"tsd-kind-class"},{"id":27,"kind":1024,"name":"partition","url":"classes/topicpartition.html#partition","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TopicPartition"},{"id":28,"kind":1024,"name":"topic","url":"classes/topicpartition.html#topic","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TopicPartition"},{"id":29,"kind":128,"name":"AdminUtils","url":"classes/adminutils.html","classes":"tsd-kind-class"},{"id":30,"kind":2048,"name":"create","url":"classes/adminutils.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"AdminUtils"},{"id":31,"kind":2048,"name":"createTopic","url":"classes/adminutils.html#createtopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":32,"kind":2048,"name":"deleteTopic","url":"classes/adminutils.html#deletetopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":33,"kind":2048,"name":"topicExists","url":"classes/adminutils.html#topicexists","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":34,"kind":2048,"name":"changeTopicConfig","url":"classes/adminutils.html#changetopicconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":35,"kind":2048,"name":"close","url":"classes/adminutils.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":36,"kind":128,"name":"KafkaConsumer","url":"classes/kafkaconsumer.html","classes":"tsd-kind-class"},{"id":37,"kind":2048,"name":"create","url":"classes/kafkaconsumer.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KafkaConsumer"},{"id":38,"kind":2048,"name":"exceptionHandler","url":"classes/kafkaconsumer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":39,"kind":2048,"name":"handler","url":"classes/kafkaconsumer.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":40,"kind":2048,"name":"pause","url":"classes/kafkaconsumer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":41,"kind":2048,"name":"resume","url":"classes/kafkaconsumer.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":42,"kind":2048,"name":"endHandler","url":"classes/kafkaconsumer.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":43,"kind":2048,"name":"subscribe","url":"classes/kafkaconsumer.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":44,"kind":2048,"name":"assign","url":"classes/kafkaconsumer.html#assign","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":45,"kind":2048,"name":"assignment","url":"classes/kafkaconsumer.html#assignment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":46,"kind":2048,"name":"unsubscribe","url":"classes/kafkaconsumer.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":47,"kind":2048,"name":"subscription","url":"classes/kafkaconsumer.html#subscription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":48,"kind":2048,"name":"paused","url":"classes/kafkaconsumer.html#paused","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":49,"kind":2048,"name":"partitionsRevokedHandler","url":"classes/kafkaconsumer.html#partitionsrevokedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":50,"kind":2048,"name":"partitionsAssignedHandler","url":"classes/kafkaconsumer.html#partitionsassignedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":51,"kind":2048,"name":"seek","url":"classes/kafkaconsumer.html#seek","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":52,"kind":2048,"name":"seekToBeginning","url":"classes/kafkaconsumer.html#seektobeginning","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":53,"kind":2048,"name":"seekToEnd","url":"classes/kafkaconsumer.html#seektoend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":54,"kind":2048,"name":"commit","url":"classes/kafkaconsumer.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":55,"kind":2048,"name":"committed","url":"classes/kafkaconsumer.html#committed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":56,"kind":2048,"name":"partitionsFor","url":"classes/kafkaconsumer.html#partitionsfor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":57,"kind":2048,"name":"batchHandler","url":"classes/kafkaconsumer.html#batchhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":58,"kind":2048,"name":"close","url":"classes/kafkaconsumer.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":59,"kind":2048,"name":"position","url":"classes/kafkaconsumer.html#position","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":60,"kind":2048,"name":"offsetsForTimes","url":"classes/kafkaconsumer.html#offsetsfortimes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":61,"kind":2048,"name":"beginningOffsets","url":"classes/kafkaconsumer.html#beginningoffsets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":62,"kind":2048,"name":"endOffsets","url":"classes/kafkaconsumer.html#endoffsets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":63,"kind":2048,"name":"pollTimeout","url":"classes/kafkaconsumer.html#polltimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":64,"kind":128,"name":"KafkaConsumerRecord","url":"classes/kafkaconsumerrecord.html","classes":"tsd-kind-class"},{"id":65,"kind":2048,"name":"topic","url":"classes/kafkaconsumerrecord.html#topic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":66,"kind":2048,"name":"partition","url":"classes/kafkaconsumerrecord.html#partition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":67,"kind":2048,"name":"offset","url":"classes/kafkaconsumerrecord.html#offset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":68,"kind":2048,"name":"timestamp","url":"classes/kafkaconsumerrecord.html#timestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":69,"kind":2048,"name":"timestampType","url":"classes/kafkaconsumerrecord.html#timestamptype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":70,"kind":2048,"name":"checksum","url":"classes/kafkaconsumerrecord.html#checksum","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":71,"kind":2048,"name":"key","url":"classes/kafkaconsumerrecord.html#key","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":72,"kind":2048,"name":"value","url":"classes/kafkaconsumerrecord.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":73,"kind":128,"name":"KafkaConsumerRecords","url":"classes/kafkaconsumerrecords.html","classes":"tsd-kind-class"},{"id":74,"kind":2048,"name":"size","url":"classes/kafkaconsumerrecords.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecords"},{"id":75,"kind":2048,"name":"isEmpty","url":"classes/kafkaconsumerrecords.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecords"},{"id":76,"kind":2048,"name":"recordAt","url":"classes/kafkaconsumerrecords.html#recordat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecords"},{"id":77,"kind":128,"name":"KafkaProducer","url":"classes/kafkaproducer.html","classes":"tsd-kind-class"},{"id":78,"kind":2048,"name":"createShared","url":"classes/kafkaproducer.html#createshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KafkaProducer"},{"id":79,"kind":2048,"name":"create","url":"classes/kafkaproducer.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KafkaProducer"},{"id":80,"kind":2048,"name":"exceptionHandler","url":"classes/kafkaproducer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":81,"kind":2048,"name":"write","url":"classes/kafkaproducer.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":82,"kind":2048,"name":"end","url":"classes/kafkaproducer.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":83,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/kafkaproducer.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":84,"kind":2048,"name":"writeQueueFull","url":"classes/kafkaproducer.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":85,"kind":2048,"name":"drainHandler","url":"classes/kafkaproducer.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":86,"kind":2048,"name":"partitionsFor","url":"classes/kafkaproducer.html#partitionsfor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":87,"kind":2048,"name":"flush","url":"classes/kafkaproducer.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":88,"kind":2048,"name":"close","url":"classes/kafkaproducer.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":89,"kind":128,"name":"KafkaProducerRecord","url":"classes/kafkaproducerrecord.html","classes":"tsd-kind-class"},{"id":90,"kind":2048,"name":"create","url":"classes/kafkaproducerrecord.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KafkaProducerRecord"},{"id":91,"kind":2048,"name":"topic","url":"classes/kafkaproducerrecord.html#topic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":92,"kind":2048,"name":"key","url":"classes/kafkaproducerrecord.html#key","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":93,"kind":2048,"name":"value","url":"classes/kafkaproducerrecord.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":94,"kind":2048,"name":"timestamp","url":"classes/kafkaproducerrecord.html#timestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":95,"kind":2048,"name":"partition","url":"classes/kafkaproducerrecord.html#partition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"Node","url":"classes/node.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/node.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Node"},{"id":2,"kind":2048,"name":"isEmpty","url":"classes/node.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":3,"kind":2048,"name":"hasRack","url":"classes/node.html#hasrack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":4,"kind":2048,"name":"setHasRack","url":"classes/node.html#sethasrack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":5,"kind":2048,"name":"getHost","url":"classes/node.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":6,"kind":2048,"name":"setHost","url":"classes/node.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":7,"kind":2048,"name":"getId","url":"classes/node.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":8,"kind":2048,"name":"setId","url":"classes/node.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":9,"kind":2048,"name":"getIdString","url":"classes/node.html#getidstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":10,"kind":2048,"name":"setIdString","url":"classes/node.html#setidstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":11,"kind":2048,"name":"setIsEmpty","url":"classes/node.html#setisempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":12,"kind":2048,"name":"getPort","url":"classes/node.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":13,"kind":2048,"name":"setPort","url":"classes/node.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":14,"kind":2048,"name":"rack","url":"classes/node.html#rack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":15,"kind":2048,"name":"setRack","url":"classes/node.html#setrack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Node"},{"id":16,"kind":128,"name":"OffsetAndMetadata","url":"classes/offsetandmetadata.html","classes":"tsd-kind-class"},{"id":17,"kind":512,"name":"constructor","url":"classes/offsetandmetadata.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":18,"kind":2048,"name":"getMetadata","url":"classes/offsetandmetadata.html#getmetadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":19,"kind":2048,"name":"setMetadata","url":"classes/offsetandmetadata.html#setmetadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":20,"kind":2048,"name":"getOffset","url":"classes/offsetandmetadata.html#getoffset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":21,"kind":2048,"name":"setOffset","url":"classes/offsetandmetadata.html#setoffset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndMetadata"},{"id":22,"kind":128,"name":"OffsetAndTimestamp","url":"classes/offsetandtimestamp.html","classes":"tsd-kind-class"},{"id":23,"kind":512,"name":"constructor","url":"classes/offsetandtimestamp.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":24,"kind":2048,"name":"getOffset","url":"classes/offsetandtimestamp.html#getoffset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":25,"kind":2048,"name":"setOffset","url":"classes/offsetandtimestamp.html#setoffset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":26,"kind":2048,"name":"getTimestamp","url":"classes/offsetandtimestamp.html#gettimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":27,"kind":2048,"name":"setTimestamp","url":"classes/offsetandtimestamp.html#settimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OffsetAndTimestamp"},{"id":28,"kind":128,"name":"PartitionInfo","url":"classes/partitioninfo.html","classes":"tsd-kind-class"},{"id":29,"kind":512,"name":"constructor","url":"classes/partitioninfo.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PartitionInfo"},{"id":30,"kind":2048,"name":"getInSyncReplicas","url":"classes/partitioninfo.html#getinsyncreplicas","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":31,"kind":2048,"name":"setInSyncReplicas","url":"classes/partitioninfo.html#setinsyncreplicas","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":32,"kind":2048,"name":"getLeader","url":"classes/partitioninfo.html#getleader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":33,"kind":2048,"name":"setLeader","url":"classes/partitioninfo.html#setleader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":34,"kind":2048,"name":"getPartition","url":"classes/partitioninfo.html#getpartition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":35,"kind":2048,"name":"setPartition","url":"classes/partitioninfo.html#setpartition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":36,"kind":2048,"name":"getReplicas","url":"classes/partitioninfo.html#getreplicas","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":37,"kind":2048,"name":"setReplicas","url":"classes/partitioninfo.html#setreplicas","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":38,"kind":2048,"name":"getTopic","url":"classes/partitioninfo.html#gettopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":39,"kind":2048,"name":"setTopic","url":"classes/partitioninfo.html#settopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PartitionInfo"},{"id":40,"kind":128,"name":"RecordMetadata","url":"classes/recordmetadata.html","classes":"tsd-kind-class"},{"id":41,"kind":512,"name":"constructor","url":"classes/recordmetadata.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RecordMetadata"},{"id":42,"kind":2048,"name":"checksum","url":"classes/recordmetadata.html#checksum","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":43,"kind":2048,"name":"setChecksum","url":"classes/recordmetadata.html#setchecksum","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":44,"kind":2048,"name":"getOffset","url":"classes/recordmetadata.html#getoffset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":45,"kind":2048,"name":"setOffset","url":"classes/recordmetadata.html#setoffset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":46,"kind":2048,"name":"getPartition","url":"classes/recordmetadata.html#getpartition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":47,"kind":2048,"name":"setPartition","url":"classes/recordmetadata.html#setpartition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":48,"kind":2048,"name":"getTimestamp","url":"classes/recordmetadata.html#gettimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":49,"kind":2048,"name":"setTimestamp","url":"classes/recordmetadata.html#settimestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":50,"kind":2048,"name":"getTopic","url":"classes/recordmetadata.html#gettopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":51,"kind":2048,"name":"setTopic","url":"classes/recordmetadata.html#settopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RecordMetadata"},{"id":52,"kind":128,"name":"TopicPartition","url":"classes/topicpartition.html","classes":"tsd-kind-class"},{"id":53,"kind":512,"name":"constructor","url":"classes/topicpartition.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TopicPartition"},{"id":54,"kind":2048,"name":"getPartition","url":"classes/topicpartition.html#getpartition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TopicPartition"},{"id":55,"kind":2048,"name":"setPartition","url":"classes/topicpartition.html#setpartition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TopicPartition"},{"id":56,"kind":2048,"name":"getTopic","url":"classes/topicpartition.html#gettopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TopicPartition"},{"id":57,"kind":2048,"name":"setTopic","url":"classes/topicpartition.html#settopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TopicPartition"},{"id":58,"kind":128,"name":"AdminUtils","url":"classes/adminutils.html","classes":"tsd-kind-class"},{"id":59,"kind":2048,"name":"create","url":"classes/adminutils.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"AdminUtils"},{"id":60,"kind":2048,"name":"createTopic","url":"classes/adminutils.html#createtopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":61,"kind":2048,"name":"deleteTopic","url":"classes/adminutils.html#deletetopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":62,"kind":2048,"name":"topicExists","url":"classes/adminutils.html#topicexists","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":63,"kind":2048,"name":"changeTopicConfig","url":"classes/adminutils.html#changetopicconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":64,"kind":2048,"name":"close","url":"classes/adminutils.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"AdminUtils"},{"id":65,"kind":128,"name":"KafkaConsumer","url":"classes/kafkaconsumer.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":66,"kind":2048,"name":"fetch","url":"classes/kafkaconsumer.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":67,"kind":2048,"name":"create","url":"classes/kafkaconsumer.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"KafkaConsumer"},{"id":68,"kind":2048,"name":"exceptionHandler","url":"classes/kafkaconsumer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":69,"kind":2048,"name":"handler","url":"classes/kafkaconsumer.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":70,"kind":2048,"name":"pause","url":"classes/kafkaconsumer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":71,"kind":2048,"name":"resume","url":"classes/kafkaconsumer.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":72,"kind":2048,"name":"endHandler","url":"classes/kafkaconsumer.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":73,"kind":2048,"name":"subscribe","url":"classes/kafkaconsumer.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":74,"kind":2048,"name":"assign","url":"classes/kafkaconsumer.html#assign","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":75,"kind":2048,"name":"assignment","url":"classes/kafkaconsumer.html#assignment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":76,"kind":2048,"name":"unsubscribe","url":"classes/kafkaconsumer.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":77,"kind":2048,"name":"subscription","url":"classes/kafkaconsumer.html#subscription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":78,"kind":2048,"name":"paused","url":"classes/kafkaconsumer.html#paused","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":79,"kind":2048,"name":"partitionsRevokedHandler","url":"classes/kafkaconsumer.html#partitionsrevokedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":80,"kind":2048,"name":"partitionsAssignedHandler","url":"classes/kafkaconsumer.html#partitionsassignedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":81,"kind":2048,"name":"seek","url":"classes/kafkaconsumer.html#seek","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":82,"kind":2048,"name":"seekToBeginning","url":"classes/kafkaconsumer.html#seektobeginning","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":83,"kind":2048,"name":"seekToEnd","url":"classes/kafkaconsumer.html#seektoend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":84,"kind":2048,"name":"commit","url":"classes/kafkaconsumer.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":85,"kind":2048,"name":"committed","url":"classes/kafkaconsumer.html#committed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":86,"kind":2048,"name":"partitionsFor","url":"classes/kafkaconsumer.html#partitionsfor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":87,"kind":2048,"name":"batchHandler","url":"classes/kafkaconsumer.html#batchhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":88,"kind":2048,"name":"close","url":"classes/kafkaconsumer.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":89,"kind":2048,"name":"position","url":"classes/kafkaconsumer.html#position","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":90,"kind":2048,"name":"offsetsForTimes","url":"classes/kafkaconsumer.html#offsetsfortimes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":91,"kind":2048,"name":"beginningOffsets","url":"classes/kafkaconsumer.html#beginningoffsets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":92,"kind":2048,"name":"endOffsets","url":"classes/kafkaconsumer.html#endoffsets","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":93,"kind":2048,"name":"pollTimeout","url":"classes/kafkaconsumer.html#polltimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":94,"kind":2048,"name":"poll","url":"classes/kafkaconsumer.html#poll","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumer"},{"id":95,"kind":128,"name":"KafkaConsumerRecord","url":"classes/kafkaconsumerrecord.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":96,"kind":2048,"name":"topic","url":"classes/kafkaconsumerrecord.html#topic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":97,"kind":2048,"name":"partition","url":"classes/kafkaconsumerrecord.html#partition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":98,"kind":2048,"name":"offset","url":"classes/kafkaconsumerrecord.html#offset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":99,"kind":2048,"name":"timestamp","url":"classes/kafkaconsumerrecord.html#timestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":100,"kind":2048,"name":"timestampType","url":"classes/kafkaconsumerrecord.html#timestamptype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":101,"kind":2048,"name":"checksum","url":"classes/kafkaconsumerrecord.html#checksum","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":102,"kind":2048,"name":"key","url":"classes/kafkaconsumerrecord.html#key","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":103,"kind":2048,"name":"value","url":"classes/kafkaconsumerrecord.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":104,"kind":2048,"name":"headers","url":"classes/kafkaconsumerrecord.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecord"},{"id":105,"kind":128,"name":"KafkaConsumerRecords","url":"classes/kafkaconsumerrecords.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":106,"kind":2048,"name":"size","url":"classes/kafkaconsumerrecords.html#size","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecords"},{"id":107,"kind":2048,"name":"isEmpty","url":"classes/kafkaconsumerrecords.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecords"},{"id":108,"kind":2048,"name":"recordAt","url":"classes/kafkaconsumerrecords.html#recordat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaConsumerRecords"},{"id":109,"kind":128,"name":"KafkaHeader","url":"classes/kafkaheader.html","classes":"tsd-kind-class"},{"id":110,"kind":2048,"name":"header","url":"classes/kafkaheader.html#header","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"KafkaHeader"},{"id":111,"kind":2048,"name":"key","url":"classes/kafkaheader.html#key","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaHeader"},{"id":112,"kind":2048,"name":"value","url":"classes/kafkaheader.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaHeader"},{"id":113,"kind":128,"name":"KafkaProducer","url":"classes/kafkaproducer.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":114,"kind":2048,"name":"createShared","url":"classes/kafkaproducer.html#createshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"KafkaProducer"},{"id":115,"kind":2048,"name":"create","url":"classes/kafkaproducer.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"KafkaProducer"},{"id":116,"kind":2048,"name":"exceptionHandler","url":"classes/kafkaproducer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":117,"kind":2048,"name":"write","url":"classes/kafkaproducer.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":118,"kind":2048,"name":"end","url":"classes/kafkaproducer.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":119,"kind":2048,"name":"setWriteQueueMaxSize","url":"classes/kafkaproducer.html#setwritequeuemaxsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":120,"kind":2048,"name":"writeQueueFull","url":"classes/kafkaproducer.html#writequeuefull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":121,"kind":2048,"name":"drainHandler","url":"classes/kafkaproducer.html#drainhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":122,"kind":2048,"name":"partitionsFor","url":"classes/kafkaproducer.html#partitionsfor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":123,"kind":2048,"name":"flush","url":"classes/kafkaproducer.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":124,"kind":2048,"name":"close","url":"classes/kafkaproducer.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducer"},{"id":125,"kind":128,"name":"KafkaProducerRecord","url":"classes/kafkaproducerrecord.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":126,"kind":2048,"name":"create","url":"classes/kafkaproducerrecord.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"KafkaProducerRecord"},{"id":127,"kind":2048,"name":"topic","url":"classes/kafkaproducerrecord.html#topic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":128,"kind":2048,"name":"key","url":"classes/kafkaproducerrecord.html#key","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":129,"kind":2048,"name":"value","url":"classes/kafkaproducerrecord.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":130,"kind":2048,"name":"timestamp","url":"classes/kafkaproducerrecord.html#timestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":131,"kind":2048,"name":"partition","url":"classes/kafkaproducerrecord.html#partition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":132,"kind":2048,"name":"addHeader","url":"classes/kafkaproducerrecord.html#addheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":133,"kind":2048,"name":"addHeaders","url":"classes/kafkaproducerrecord.html#addheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"},{"id":134,"kind":2048,"name":"headers","url":"classes/kafkaproducerrecord.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"KafkaProducerRecord"}]}; \ No newline at end of file diff --git a/docs/@vertx/kafka-client/classes/adminutils.html b/docs/@vertx/kafka-client/classes/adminutils.html index 665e7337e..fbfafbefb 100644 --- a/docs/@vertx/kafka-client/classes/adminutils.html +++ b/docs/@vertx/kafka-client/classes/adminutils.html @@ -96,18 +96,18 @@

    Methods

    changeTopicConfig

      -
    • changeTopicConfig(topicName: string, topicConfig: Map<String, string>, completionHandler: function): void
      • +
    • changeTopicConfig(topicName: string, topicConfig: object, completionHandler: function): void
    • -

      Updates the configuration of the topic given by topicName. Configuration parameters +

      Updates the configuration of the topic given by topicName. Configuration parameters are passed in as a Map (Key -> Value) of Strings.

      @@ -120,10 +120,15 @@
      topicName: string
  • -
    topicConfig: Map<String, string>
    +
    topicConfig: object

    Map with configuration items

    +
      +
    • +
      [key: string]: string
      +
      • +
  • completionHandler: function
    @@ -133,17 +138,20 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -164,12 +172,12 @@

      close

    • -

      Closes the underlying connection to Zookeeper. It is required to call the method for cleanup +

      Closes the underlying connection to Zookeeper. It is required to call the method for cleanup purposes if AdminUtils was not created with autoClose set to true.

      @@ -183,17 +191,20 @@
      completionHandler: function
        • -
        • (result: AsyncResult<void>): void
          • +
        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

        • Parameters

          • -
            result: AsyncResult<void>
            +
            res: AsyncResult<void>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<void>> +

        • @@ -209,18 +220,18 @@

        Returns voidcreateTopic

        • createTopic(topicName: string, partitionCount: number, replicationFactor: number, completionHandler: function): void
          • -
        • createTopic(topicName: string, partitionCount: number, replicationFactor: number, topicConfig: Map<String, string>, completionHandler: function): void
          • +
        • createTopic(topicName: string, partitionCount: number, replicationFactor: number, topicConfig: object, completionHandler: function): void
        • -

          Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s)

          +

          Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s)

          Parameters

          @@ -251,17 +262,20 @@
          completionHandler: function
            • -
            • (result: AsyncResult<void>): void
              • +
            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

            • Parameters

              • -
                result: AsyncResult<void>
                +
                res: AsyncResult<void>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<void>> +

            • @@ -273,12 +287,12 @@

            Returns void
            -

            Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s). In contrast +

            Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s). In contrast to @see {@link #createTopic(String, int, int, Handler)}, one can pass in additional configuration parameters as a map (String -> String).

            @@ -304,10 +318,15 @@
            replicationFactor: number
          • -
            topicConfig: Map<String, string>
            +
            topicConfig: object

            map with additional topic configuration parameters

            +
              +
            • +
              [key: string]: string
              +
              • +
          • completionHandler: function
            @@ -317,17 +336,20 @@
            completionHandler: function

    • +
    +

    Type parameters

    +
      +
    • +

      K

      +
      • +
    • +

      V

      +
      • +
    +

    Hierarchy

      @@ -72,6 +83,12 @@

      Hierarchy

    +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -89,6 +106,7 @@

    Methods

  • endHandler
  • endOffsets
  • exceptionHandler
    • +
  • fetch
  • handler
  • offsetsForTimes
  • partitionsAssignedHandler
    • @@ -96,6 +114,7 @@

    Methods

  • partitionsRevokedHandler
  • pause
  • paused
    • +
  • poll
  • pollTimeout
  • position
  • resume
    • @@ -105,7 +124,7 @@

    Methods

  • subscribe
  • subscription
  • unsubscribe
    • -
  • create
    • +
  • create
    • @@ -117,21 +136,21 @@

    Methods

    assign

    • -

      Manually assign a partition to this consumer.

      +

      Manually assign a partition to this consumer.

      Parameters

      @@ -143,18 +162,18 @@
      topicPartition: Top
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Manually assign a list of partition to this consumer.

    +

    Manually assign a list of partition to this consumer.

    Parameters

    @@ -166,18 +185,18 @@
    topicPartitions: To
    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Manually assign a partition to this consumer. +

    Manually assign a partition to this consumer.

    Due to internal buffering of messages, when reassigning the old partition may remain in effect @@ -204,35 +223,38 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Manually assign a list of partition to this consumer. +

    Manually assign a list of partition to this consumer.

    Due to internal buffering of messages, when reassigning the old set of partitions may remain in effect @@ -259,24 +281,27 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -285,18 +310,18 @@

    Returns

    assignment

    • -

      Get the set of partitions currently assigned to this consumer.

      +

      Get the set of partitions currently assigned to this consumer.

      Parameters

      @@ -309,24 +334,27 @@
      handler: function
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -335,18 +363,18 @@

    Returns

    batchHandler

    • -

      Set the handler to be used when batches of messages are fetched +

      Set the handler to be used when batches of messages are fetched from the Kafka server. Batch handlers need to take care not to block the event loop when dealing with large batches. It is better to process records individually using the {@link #handler(Handler) record handler}.

      @@ -362,24 +390,27 @@
      handler: function
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -394,12 +425,12 @@

    beginningOffsets

  • -

    Get the first offset for the given partitions.

    +

    Get the first offset for the given partitions.

    Parameters

    @@ -418,17 +449,20 @@
    handler: function
      • -
      • (result: AsyncResult<number>): void
        • +
      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

      • Parameters

        • -
          result: AsyncResult<number>
          +
          res: AsyncResult<number>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<number>> +

      • @@ -450,12 +484,12 @@

      close

    • -

      Close the consumer

      +

      Close the consumer

      Returns void

      @@ -463,12 +497,12 @@

      Returns void
      -

      Close the consumer

      +

      Close the consumer

      Parameters

      @@ -481,17 +515,20 @@
      completionHandler: function
        • -
        • (result: AsyncResult<void>): void
          • +
        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

        • Parameters

          • -
            result: AsyncResult<void>
            +
            res: AsyncResult<void>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<void>> +

        • @@ -513,12 +550,12 @@

        commit

      • -

        Commit current offsets for all the subscribed list of topics and partition.

        +

        Commit current offsets for all the subscribed list of topics and partition.

        Returns void

        @@ -526,12 +563,12 @@

        Returns void
        -

        Commit current offsets for all the subscribed list of topics and partition.

        +

        Commit current offsets for all the subscribed list of topics and partition.

        Parameters

        @@ -544,17 +581,20 @@
        completionHandler: function
          • -
          • (result: AsyncResult<void>): void
            • +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

          • Parameters

            • -
              result: AsyncResult<void>
              +
              res: AsyncResult<void>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<void>> +

          • @@ -575,12 +615,12 @@

          committed

        • -

          Get the last committed offset for the given partition (whether the commit happened by this process or another).

          +

          Get the last committed offset for the given partition (whether the commit happened by this process or another).

          Parameters

          @@ -599,17 +639,20 @@
          handler: function
            • @@ -624,13 +667,13 @@

            Returns void

            endHandler

            • Parameters

              @@ -640,17 +683,19 @@
              endHandler: function
                • -
                • (result: void): void | null | undefined
                  • +
                • (res: void): void | Handler<void> | null | undefined

                • Parameters

                  • -
                    result: void
                    +
                    res: void

                  Returns void + | + Handler<void> | null | @@ -662,7 +707,7 @@

                  Returns void

                -

                Returns KafkaConsumer

                +

                Returns KafkaConsumer<K, V>

    • @@ -676,12 +721,12 @@

    endOffsets

  • -

    Get the last offset for the given partition. The last offset of a partition is the offset +

    Get the last offset for the given partition. The last offset of a partition is the offset of the upcoming message, i.e. the offset of the last available message + 1.

    @@ -701,17 +746,20 @@
    handler: function
      • -
      • (result: AsyncResult<number>): void
        • +
      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

      • Parameters

        • -
          result: AsyncResult<number>
          +
          res: AsyncResult<number>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<number>> +

      • @@ -726,13 +774,13 @@

      Returns void

      exceptionHandler

      • Parameters

        @@ -742,17 +790,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -764,7 +814,30 @@

            Returns void

          -

          Returns KafkaConsumer

          +

          Returns KafkaConsumer<K, V>

          +
          • +
        +

    • +
    + +

    fetch

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        arg0: number
        +
        • +
      +

      Returns ReadStream<KafkaConsumerRecord<K, V>>

    @@ -772,13 +845,13 @@

    Returns

    handler

    @@ -824,12 +899,12 @@

    offsetsForTimes

  • -

    Look up the offset for the given partition by timestamp. Note: the result might be null in case +

    Look up the offset for the given partition by timestamp. Note: the result might be null in case for the given timestamp no offset can be found -- e.g., when the timestamp refers to the future

    @@ -855,17 +930,20 @@
    handler: function
    @@ -930,18 +1011,18 @@

    Returns

    partitionsFor

      -
    • partitionsFor(topic: string, handler: function): KafkaConsumer
      • +
    • partitionsFor(topic: string, handler: function): KafkaConsumer<K, V>
    • -

      Get metadata about the partitions for a given topic.

      +

      Get metadata about the partitions for a given topic.

      Parameters

      @@ -960,24 +1041,27 @@
      handler: function
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    • @@ -986,18 +1070,18 @@

    Returns

    partitionsRevokedHandler

    • -

      Set the handler called when topic partitions are revoked to the consumer

      +

      Set the handler called when topic partitions are revoked to the consumer

      Parameters

      @@ -1010,24 +1094,27 @@
      handler: function
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -1036,30 +1123,30 @@

    Returns

    pause

    • -

      Returns KafkaConsumer

      +

      Returns KafkaConsumer<K, V>

    • -

      Suspend fetching from the requested partition.

      +

      Suspend fetching from the requested partition.

      Parameters

      @@ -1071,18 +1158,18 @@
      topicPartition: Top
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Suspend fetching from the requested partitions.

    +

    Suspend fetching from the requested partitions.

    Parameters

    @@ -1094,26 +1181,26 @@
    topicPartitions: To
    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Suspend fetching from the requested partition. +

    Suspend fetching from the requested partition.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will - continue to observe messages from the given {@code topicParation} + continue to observe messages from the given {@code topicPartition} until some time after the given {@code completionHandler} is called. In contrast, the once the given {@code completionHandler} is called the {@link #batchHandler(Handler)} will not see messages - from the given {@code topicParation}.

    + from the given {@code topicPartition}.

    Parameters

    @@ -1132,43 +1219,46 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Suspend fetching from the requested partitions. +

    Suspend fetching from the requested partitions.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will - continue to observe messages from the given {@code topicParations} + continue to observe messages from the given {@code topicPartitions} until some time after the given {@code completionHandler} is called. In contrast, the once the given {@code completionHandler} is called the {@link #batchHandler(Handler)} will not see messages - from the given {@code topicParations}.

    + from the given {@code topicPartitions}.

    Parameters

    @@ -1187,24 +1277,27 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -1219,12 +1312,12 @@

    paused

  • -

    Get the set of partitions that were previously paused by a call to pause(Set).

    +

    Get the set of partitions that were previously paused by a call to pause(Set).

    Parameters

    @@ -1237,17 +1330,80 @@
    handler: function
    +
    • + +

    Returns void

    + + +
    +
    + +

    poll

    +
      +
    • poll(timeout: number, handler: function): void
      • +
    +
      +
    • + +
      +
      +

      Executes a poll for getting messages from Kafka

      +
      +
      +

      Parameters

      +
        +
      • +
        timeout: number
        +
        +

        The time, in milliseconds, spent waiting in poll if data is not available in the buffer. + If 0, returns immediately with any records that are available currently in the native Kafka consumer's buffer, + else returns empty. Must not be negative.

        +
        +
        • +
      • +
        handler: function
        +
        +

        handler called after the poll with batch of records (can be empty).

        +
        +
          +
        • +
          • @@ -1262,18 +1418,18 @@

          Returns void

          pollTimeout

          • -

            Sets the poll timeout (in ms) for the underlying native Kafka Consumer. Defaults to 1000. +

            Sets the poll timeout (in ms) for the underlying native Kafka Consumer. Defaults to 1000. Setting timeout to a lower value results in a more 'responsive' client, because it will block for a shorter period if no data is available in the assigned partition and therefore allows subsequent actions to be executed with a shorter delay. At the same time, the client will poll more frequently and thus will potentially create a higher load on the Kafka Broker.

            @@ -1290,7 +1446,7 @@
            timeout: number
          -

          Returns KafkaConsumer

          +

          Returns KafkaConsumer<K, V>

    @@ -1304,12 +1460,12 @@

    position

  • -

    Get the offset of the next record that will be fetched (if a record with that offset exists).

    +

    Get the offset of the next record that will be fetched (if a record with that offset exists).

    Parameters

    @@ -1328,17 +1484,20 @@
    handler: function
      • -
      • (result: AsyncResult<number>): void
        • +
      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

      • Parameters

        • -
          result: AsyncResult<number>
          +
          res: AsyncResult<number>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<number>> +

      • @@ -1353,30 +1512,30 @@

      Returns void

      resume

      • -

        Returns KafkaConsumer

        +

        Returns KafkaConsumer<K, V>

      • -

        Resume specified partition which have been paused with pause.

        +

        Resume specified partition which have been paused with pause.

        Parameters

        @@ -1388,18 +1547,18 @@
        topicPartition: Top
      -

      Returns KafkaConsumer

      +

      Returns KafkaConsumer<K, V>

      current KafkaConsumer instance

    • -

      Resume specified partitions which have been paused with pause.

      +

      Resume specified partitions which have been paused with pause.

      Parameters

      @@ -1411,18 +1570,18 @@
      topicPartitions: To

    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Resume specified partition which have been paused with pause.

    +

    Resume specified partition which have been paused with pause.

    Parameters

    @@ -1441,35 +1600,38 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Resume specified partitions which have been paused with pause.

    +

    Resume specified partitions which have been paused with pause.

    Parameters

    @@ -1488,24 +1650,27 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -1514,19 +1679,19 @@

    Returns

    seek

    • -

      Overrides the fetch offsets that the consumer will use on the next poll.

      +

      Overrides the fetch offsets that the consumer will use on the next poll.

      Parameters

      @@ -1544,18 +1709,18 @@
      offset: number
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Overrides the fetch offsets that the consumer will use on the next poll. +

    Overrides the fetch offsets that the consumer will use on the next poll.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will @@ -1588,24 +1753,27 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -1614,21 +1782,21 @@

    Returns

    seekToBeginning

    • -

      Seek to the first offset for each of the given partition.

      +

      Seek to the first offset for each of the given partition.

      Parameters

      @@ -1640,18 +1808,18 @@
      topicPartition: Top
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Seek to the first offset for each of the given partitions.

    +

    Seek to the first offset for each of the given partitions.

    Parameters

    @@ -1663,18 +1831,18 @@
    topicPartitions: To
    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Seek to the first offset for each of the given partition. +

    Seek to the first offset for each of the given partition.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will @@ -1701,35 +1869,38 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Seek to the first offset for each of the given partitions. +

    Seek to the first offset for each of the given partitions.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will @@ -1756,24 +1927,27 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -1782,21 +1956,21 @@

    Returns

    seekToEnd

    • -

      Seek to the last offset for each of the given partition.

      +

      Seek to the last offset for each of the given partition.

      Parameters

      @@ -1808,18 +1982,18 @@
      topicPartition: Top
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Seek to the last offset for each of the given partitions.

    +

    Seek to the last offset for each of the given partitions.

    Parameters

    @@ -1831,18 +2005,18 @@
    topicPartitions: To
    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Seek to the last offset for each of the given partition. +

    Seek to the last offset for each of the given partition.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will @@ -1869,35 +2043,38 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Seek to the last offset for each of the given partitions. +

    Seek to the last offset for each of the given partitions.

    Due to internal buffering of messages, the {@linkplain #handler(Handler) record handler} will @@ -1924,24 +2101,27 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -1950,21 +2130,21 @@

    Returns

    subscribe

    • -

      Subscribe to the given topic to get dynamically assigned partitions.

      +

      Subscribe to the given topic to get dynamically assigned partitions.

      Parameters

      @@ -1976,18 +2156,18 @@
      topic: string
    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Subscribe to the given list of topics to get dynamically assigned partitions.

    +

    Subscribe to the given list of topics to get dynamically assigned partitions.

    Parameters

    @@ -1999,18 +2179,18 @@
    topics: stringReturns KafkaConsumer
    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Subscribe to the given topic to get dynamically assigned partitions. +

    Subscribe to the given topic to get dynamically assigned partitions.

    Due to internal buffering of messages, when changing the subscribed topic the old topic may remain in effect @@ -2037,35 +2217,38 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

  • -

    Subscribe to the given list of topics to get dynamically assigned partitions. +

    Subscribe to the given list of topics to get dynamically assigned partitions.

    Due to internal buffering of messages, when changing the subscribed topics the old set of topics may remain in effect @@ -2092,24 +2275,27 @@

    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

    • -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -2118,18 +2304,18 @@

    Returns

    subscription

    • -

      Get the current subscription.

      +

      Get the current subscription.

      Parameters

      @@ -2142,24 +2328,27 @@
      handler: function
        • -
        • (result: AsyncResult<string[]>): void
          • +
        • (res: AsyncResult<string[]>): void | Handler<AsyncResult<string[]>>

        • Parameters

          • -
            result: AsyncResult<string[]>
            +
            res: AsyncResult<string[]>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<string[]>> +

    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    @@ -2168,33 +2357,33 @@

    Returns

    unsubscribe

    • -

      Unsubscribe from topics currently subscribed with subscribe.

      +

      Unsubscribe from topics currently subscribed with subscribe.

      -

      Returns KafkaConsumer

      +

      Returns KafkaConsumer<K, V>

      current KafkaConsumer instance

    • -

      Unsubscribe from topics currently subscribed with subscribe.

      +

      Unsubscribe from topics currently subscribed with subscribe.

      Parameters

      @@ -2207,47 +2396,59 @@
      completionHandler: function
        • -
        • (result: AsyncResult<void>): void
          • +
        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

        • Parameters

          • -
            result: AsyncResult<void>
            +
            res: AsyncResult<void>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<void>> +

    -

    Returns KafkaConsumer

    +

    Returns KafkaConsumer<K, V>

    current KafkaConsumer instance

    -
    +

    Static create

    -
      -
    • create(vertx: Vertx, config: Map<String, string>): KafkaConsumer
      • -
    • create(vertx: Vertx, config: Map<String, string>, keyType: Class, valueType: Class): KafkaConsumer
      • +
        +
      • create<K, V>(vertx: Vertx, config: object): KafkaConsumer<K, V>
        • +
      • create<K, V>(vertx: Vertx, config: object, keyType: any, valueType: any): KafkaConsumer<K, V>
      • -

        Create a new KafkaConsumer instance

        +

        Create a new KafkaConsumer instance

        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +

        Parameters

        • @@ -2257,26 +2458,40 @@
          vertx: Vertx
        • -
          config: Map<String, string>
          +
          config: object

          Kafka consumer configuration

          +
            +
          • +
            [key: string]: string
            +
            • +
        -

        Returns KafkaConsumer

        +

        Returns KafkaConsumer<K, V>

        an instance of the KafkaConsumer

      • -

        Create a new KafkaConsumer instance

        +

        Create a new KafkaConsumer instance

        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +

        Parameters

        • @@ -2286,25 +2501,30 @@
          vertx: Vertx
        • -
          config: Map<String, string>
          +
          config: object

          Kafka consumer configuration

          +
            +
          • +
            [key: string]: string
            +
            • +
        • -
          keyType: Class
          +
          keyType: any

          class type for the key deserialization

        • -
          valueType: Class
          +
          valueType: any

          class type for the value deserialization

        -

        Returns KafkaConsumer

        +

        Returns KafkaConsumer<K, V>

        an instance of the KafkaConsumer

      @@ -2326,7 +2546,7 @@

      Returns -
    • +
    • KafkaConsumer

    -

    Class KafkaConsumerRecord

    +

    Class KafkaConsumerRecord<K, V>

    +
    +

    Type parameters

    +
      +
    • +

      K

      +
      • +
    • +

      V

      +
      • +
    +

    Hierarchy

      @@ -80,6 +91,7 @@

      Index

      Methods

      • checksum
        • +
      • headers
      • key
      • offset
      • partition
        • @@ -104,32 +116,63 @@

        checksum

      • +
        +
        deprecated
        +

        As of Kafka 0.11.0. Because of the potential for message format conversion on the broker, the + checksum returned by the broker may not match what was computed by the producer. + It is therefore unsafe to depend on this checksum for end-to-end delivery guarantees. Additionally, + message format v2 does not include a record-level checksum (for performance, the record checksum + was replaced with a batch checksum). To maintain compatibility, a partial checksum computed from + the record timestamp, serialized key size, and serialized value size is returned instead, but + this should not be depended on for end-to-end reliability.

        +
        +

        Returns number

        the checksum (CRC32) of the record.

    +
    + +

    headers

    + +
      +
    • + +
      +
      +

      Returns KafkaHeader[]

      +

      the list of consumer record headers

      +
      • +
    +

    key

      -
    • key(): Object
      • +
    • key(): K
    • -

      Returns Object

      +

      Returns K

      the key (or null if no key is specified)

    @@ -144,7 +187,7 @@

    offset

  • @@ -164,7 +207,7 @@

    partition

  • @@ -184,7 +227,7 @@

    timestamp

  • @@ -198,18 +241,18 @@

    Returns number

    timestampType

      -
    • timestampType(): TimestampType
      • +
    • timestampType(): any
    • -

      Returns TimestampType

      +

      Returns any

      the timestamp type of this record

    @@ -224,7 +267,7 @@

    topic

  • @@ -238,18 +281,18 @@

    Returns string

    value

      -
    • value(): Object
      • +
    • value(): V
    • -

      Returns Object

      +

      Returns V

      the value

    @@ -269,17 +312,20 @@

    Returns Object AdminUtils

    • -
  • +
  • KafkaConsumer

    • +
    +

    Type parameters

    +
      +
    • +

      K

      +
      • +
    • +

      V

      +
      • +
    +

    Hierarchy

      @@ -99,7 +110,7 @@

      isEmpty

    • @@ -113,18 +124,18 @@

      Returns boolean

      recordAt

      • -

        Get the record at the given index

        +

        Get the record at the given index

        throws
        @@ -141,7 +152,7 @@
        index: number
      -

      Returns KafkaConsumerRecord

      +

      Returns KafkaConsumerRecord<K, V>

    @@ -155,7 +166,7 @@

    size

  • @@ -180,15 +191,15 @@

    Returns number AdminUtils

    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
      • -
    • +
    • KafkaConsumerRecords
      • @@ -205,9 +216,12 @@

        Returns number
        • + KafkaHeader +
          • +
        • KafkaProducer
          • -
        • +
        • KafkaProducerRecord
        • diff --git a/docs/@vertx/redis-client/classes/bitfieldoptions.html b/docs/@vertx/kafka-client/classes/kafkaheader.html similarity index 56% rename from docs/@vertx/redis-client/classes/bitfieldoptions.html rename to docs/@vertx/kafka-client/classes/kafkaheader.html index 19ec60e15..d724878a4 100644 --- a/docs/@vertx/redis-client/classes/bitfieldoptions.html +++ b/docs/@vertx/kafka-client/classes/kafkaheader.html @@ -3,7 +3,7 @@ - BitFieldOptions | @vertx/redis-client + KafkaHeader | @vertx/kafka-client @@ -22,7 +22,7 @@
        • Preparing search index...
        • The search index is not available
        - @vertx/redis-client + @vertx/kafka-client

    @@ -54,10 +54,10 @@ Globals
  • - BitFieldOptions + KafkaHeader
    • -

    Class BitFieldOptions

    +

    Class KafkaHeader

    @@ -68,7 +68,7 @@

    Class BitFieldOptions

    Hierarchy

    • - BitFieldOptions + KafkaHeader
    @@ -77,47 +77,101 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    get

    -
    get: BitFieldGetCommand
    - +

    Methods

    +
    + +

    key

    +
      +
    • key(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the buffer key

      +
      • +
    -
    - -

    incrby

    -
    incrby: BitFieldIncrbyCommand
    - +
    + +

    value

    +
      +
    • value(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Returns Buffer

      +

      the buffer value

      +
      • +
    -
    - -

    set

    -
    set: BitFieldSetCommand
    - +
    + +

    Static header

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        key: string
        +
        • +
      • +
        value: Buffer
        +
        • +
      +

      Returns KafkaHeader

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        key: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns KafkaHeader

      +
      • +
    @@ -131,113 +185,59 @@

    set

    diff --git a/docs/@vertx/kafka-client/classes/kafkaproducer.html b/docs/@vertx/kafka-client/classes/kafkaproducer.html index 8b28125bd..6a506bf89 100644 --- a/docs/@vertx/kafka-client/classes/kafkaproducer.html +++ b/docs/@vertx/kafka-client/classes/kafkaproducer.html @@ -57,13 +57,24 @@ KafkaProducer -

    Class KafkaProducer

    +

    Class KafkaProducer<K, V>

    +
    +

    Type parameters

    +
      +
    • +

      K

      +
      • +
    • +

      V

      +
      • +
    +

    Hierarchy

      @@ -72,6 +83,12 @@

      Hierarchy

    +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -88,8 +105,8 @@

    Methods

  • setWriteQueueMaxSize
  • write
  • writeQueueFull
    • -
  • create
    • -
  • createShared
    • +
  • create
    • +
  • createShared
    • @@ -109,12 +126,12 @@

    close

  • -

    Close the producer

    +

    Close the producer

    Returns void

    @@ -122,12 +139,12 @@

    Returns void
    -

    Close the producer

    +

    Close the producer

    Parameters

    @@ -140,17 +157,20 @@
    completionHandler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -162,12 +182,12 @@

      Returns void
      -

      Close the producer

      +

      Close the producer

      Parameters

      @@ -186,17 +206,20 @@
      completionHandler: function
        • -
        • (result: AsyncResult<void>): void
          • +
        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

        • Parameters

          • -
            result: AsyncResult<void>
            +
            res: AsyncResult<void>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<void>> +

        • @@ -211,13 +234,13 @@

        Returns void

        drainHandler

        • Parameters

          @@ -227,17 +250,19 @@
          handler: function
            • -
            • (result: void): void | null | undefined
              • +
            • (res: void): void | Handler<void> | null | undefined

            • Parameters

              • -
                result: void
                +
                res: void

              Returns void + | + Handler<void> | null | @@ -249,7 +274,7 @@

              Returns void

            -

            Returns KafkaProducer

            +

            Returns KafkaProducer<K, V>

    • @@ -258,13 +283,13 @@

    Returns
  • end(): void
    • -
  • end(kafkaProducerRecord: KafkaProducerRecord): void
    • +
  • end(kafkaProducerRecord: KafkaProducerRecord<K, V>): void

    • Returns void

      @@ -272,13 +297,13 @@

      Returns void

      Parameters

      Returns void

      @@ -289,13 +314,13 @@

      Returns void

      exceptionHandler

      • Parameters

        @@ -305,17 +330,19 @@
        handler: function
          • -
          • (result: Error): void | null | undefined
            • +
          • (res: Error): void | Handler<Error> | null | undefined

          • Parameters

            • -
              result: Error
              +
              res: Error

            Returns void + | + Handler<Error> | null | @@ -327,7 +354,7 @@

            Returns void

          -

          Returns KafkaProducer

          +

          Returns KafkaProducer<K, V>

    @@ -335,18 +362,18 @@

    Returns

    flush

    • -

      Invoking this method makes all buffered records immediately available to write

      +

      Invoking this method makes all buffered records immediately available to write

      Parameters

      @@ -359,24 +386,27 @@
      completionHandler: function
        • -
        • (result: void): void
          • +
        • (res: void): void | Handler<void>

        • Parameters

          • -
            result: void
            +
            res: void
          -

          Returns void

          +

          Returns void + | + Handler<void> +

    -

    Returns KafkaProducer

    +

    Returns KafkaProducer<K, V>

    current KafkaProducer instance

    @@ -385,18 +415,18 @@

    Returns

    partitionsFor

      -
    • partitionsFor(topic: string, handler: function): KafkaProducer
      • +
    • partitionsFor(topic: string, handler: function): KafkaProducer<K, V>
    • -

      Get the partition metadata for the give topic.

      +

      Get the partition metadata for the give topic.

      Parameters

      @@ -415,24 +445,27 @@
      handler: function
    -

    Returns KafkaProducer

    +

    Returns KafkaProducer<K, V>

    current KafkaProducer instance

    @@ -441,13 +474,13 @@

    Returns

    setWriteQueueMaxSize

    • Parameters

      @@ -456,7 +489,7 @@

      Parameters

      i: number
    -

    Returns KafkaProducer

    +

    Returns KafkaProducer<K, V>

    @@ -464,39 +497,39 @@

    Returns

    write

    @@ -541,32 +577,41 @@

    writeQueueFull

  • Returns boolean

    • -
    +

    Static create

    -
      -
    • create(vertx: Vertx, config: Map<String, string>): KafkaProducer
      • -
    • create(vertx: Vertx, config: Map<String, string>, keyType: Class, valueType: Class): KafkaProducer
      • +
        +
      • create<K, V>(vertx: Vertx, config: object): KafkaProducer<K, V>
        • +
      • create<K, V>(vertx: Vertx, config: object, keyType: any, valueType: any): KafkaProducer<K, V>
      • -

        Create a new KafkaProducer instance

        +

        Create a new KafkaProducer instance

        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +

        Parameters

        • @@ -576,26 +621,40 @@
          vertx: Vertx
        • -
          config: Map<String, string>
          +
          config: object

          Kafka producer configuration

          +
            +
          • +
            [key: string]: string
            +
            • +
        -

        Returns KafkaProducer

        +

        Returns KafkaProducer<K, V>

        an instance of the KafkaProducer

      • -

        Create a new KafkaProducer instance

        +

        Create a new KafkaProducer instance

        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +

        Parameters

        • @@ -605,48 +664,62 @@
          vertx: Vertx
        • -
          config: Map<String, string>
          +
          config: object

          Kafka producer configuration

          +
            +
          • +
            [key: string]: string
            +
            • +
        • -
          keyType: Class
          +
          keyType: any

          class type for the key serialization

        • -
          valueType: Class
          +
          valueType: any

          class type for the value serialization

        -

        Returns KafkaProducer

        +

        Returns KafkaProducer<K, V>

        an instance of the KafkaProducer

    -
    +

    Static createShared

    -
      -
    • createShared(vertx: Vertx, name: string, config: Map<String, string>): KafkaProducer
      • -
    • createShared(vertx: Vertx, name: string, config: Map<String, string>, keyType: Class, valueType: Class): KafkaProducer
      • +
        +
      • createShared<K, V>(vertx: Vertx, name: string, config: object): KafkaProducer<K, V>
        • +
      • createShared<K, V>(vertx: Vertx, name: string, config: object, keyType: any, valueType: any): KafkaProducer<K, V>
      • -

        Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same {@code name}

        +

        Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same {@code name}

        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +

        Parameters

        • @@ -662,26 +735,40 @@
          name: string
        • -
          config: Map<String, string>
          +
          config: object

          Kafka producer configuration

          +
            +
          • +
            [key: string]: string
            +
            • +
        -

        Returns KafkaProducer

        +

        Returns KafkaProducer<K, V>

        an instance of the KafkaProducer

      • -

        Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same {@code name}

        +

        Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same {@code name}

        +

        Type parameters

        +
          +
        • +

          K

          +
          • +
        • +

          V

          +
          • +

        Parameters

        • @@ -697,25 +784,30 @@
          name: string
        • -
          config: Map<String, string>
          +
          config: object

          Kafka producer configuration

          +
            +
          • +
            [key: string]: string
            +
            • +
        • -
          keyType: Class
          +
          keyType: any

          class type for the key serialization

        • -
          valueType: Class
          +
          valueType: any

          class type for the value serialization

        -

        Returns KafkaProducer

        +

        Returns KafkaProducer<K, V>

        an instance of the KafkaProducer

      @@ -735,18 +827,21 @@

      Returns AdminUtils -
    • +
    • KafkaConsumer
      • -
    • +
    • KafkaConsumerRecord
      • -
    • +
    • KafkaConsumerRecords
      • +
    • + KafkaHeader +

      -
    • +
    • KafkaProducerRecord
    • diff --git a/docs/@vertx/kafka-client/classes/kafkaproducerrecord.html b/docs/@vertx/kafka-client/classes/kafkaproducerrecord.html index e6001a449..6c075d99f 100644 --- a/docs/@vertx/kafka-client/classes/kafkaproducerrecord.html +++ b/docs/@vertx/kafka-client/classes/kafkaproducerrecord.html @@ -57,13 +57,24 @@ KafkaProducerRecord
    -

    Class KafkaProducerRecord

    +

    Class KafkaProducerRecord<K, V>

    +
    +

    Type parameters

    +
      +
    • +

      K

      +
      • +
    • +

      V

      +
      • +
    +

    Hierarchy

    @@ -92,22 +106,152 @@

    Methods

    Methods

    +
    + +

    addHeader

    + +
      +
    • + +
      +
      +

      Like {@link #addHeader(KafkaHeader)} but with a key/value pair

      +
      +
      +

      Parameters

      +
        +
      • +
        key: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns KafkaProducerRecord<K, V>

      +
      • +
    • + +
      +
      +

      Like {@link #addHeader(KafkaHeader)} but with a key/value pair

      +
      +
      +

      Parameters

      +
        +
      • +
        key: string
        +
        • +
      • +
        value: Buffer
        +
        • +
      +

      Returns KafkaProducerRecord<K, V>

      +
      • +
    • + +
      +
      +

      Add an header to this record.

      +
      +
      +

      Parameters

      + +

      Returns KafkaProducerRecord<K, V>

      +

      current KafkaProducerRecord instance

      +
      • +
    +
    +
    + +

    addHeaders

    + +
      +
    • + +
      +
      +

      Add a list of headers to this record.

      +
      +
      +

      Parameters

      + +

      Returns KafkaProducerRecord<K, V>

      +

      current KafkaProducerRecord instance

      +
      • +
    +
    +
    + +

    headers

    + +
      +
    • + +
      +
      +

      Returns KafkaHeader[]

      +

      the headers of this record

      +
      • +
    +

    key

      -
    • key(): Object
      • +
    • key(): K
    • -

      Returns Object

      +

      Returns K

      the key (or null if no key is specified)

    @@ -122,7 +266,7 @@

    partition

  • @@ -142,7 +286,7 @@

    timestamp

  • @@ -162,7 +306,7 @@

    topic

  • @@ -176,42 +320,57 @@

    Returns string

    value

      -
    • value(): Object
      • +
    • value(): V
    • -

      Returns Object

      +

      Returns V

      the value

    • -
    +

    Static create

    -
      -
    • create(topic: string, key: any, value: any, timestamp: number, partition: number): KafkaProducerRecord
      • -
    • create(topic: string, key: any, value: any): KafkaProducerRecord
      • -
    • create(topic: string, value: any): KafkaProducerRecord
      • +
      • -

        Create a concrete instance of a Vert.x producer record

        +

        Create a concrete instance of a Vert.x producer record

        +

        Type parameters

        +
          +
        • +

          K

          +
          +

          key type

          +
          +
          • +
        • +

          V

          +
          +

          value type

          +
          +
          • +

        Parameters

        • @@ -221,13 +380,13 @@
          topic: string
        • -
          key: any
          +
          key: K

          the key (or null if no key is specified)

        • -
          value: any
          +
          value: V

          the value

          @@ -245,20 +404,35 @@
          partition: number
        -

        Returns KafkaProducerRecord

        +

        Returns KafkaProducerRecord<K, V>

        Vert.x producer record

      • -

        Create a concrete instance of a Vert.x producer record

        +

        Create a concrete instance of a Vert.x producer record

        +

        Type parameters

        +
          +
        • +

          K

          +
          +

          key type

          +
          +
          • +
        • +

          V

          +
          +

          value type

          +
          +
          • +

        Parameters

        • @@ -268,32 +442,47 @@
          topic: string
        • -
          key: any
          +
          key: K

          the key (or null if no key is specified)

        • -
          value: any
          +
          value: V

          the value

        -

        Returns KafkaProducerRecord

        +

        Returns KafkaProducerRecord<K, V>

        Vert.x producer record

      • -

        Create a concrete instance of a Vert.x producer record

        +

        Create a concrete instance of a Vert.x producer record

        +

        Type parameters

        +
          +
        • +

          K

          +
          +

          key type

          +
          +
          • +
        • +

          V

          +
          +

          value type

          +
          +
          • +

        Parameters

        • @@ -303,13 +492,13 @@
          topic: string
        • -
          value: any
          +
          value: V

          the value

        -

        Returns KafkaProducerRecord

        +

        Returns KafkaProducerRecord<K, V>

        Vert.x producer record

      @@ -329,23 +518,35 @@

      Returns AdminUtils -
    • +
    • KafkaConsumer
      • -
    • +
    • KafkaConsumerRecord
      • -
    • +
    • KafkaConsumerRecords
    • + KafkaHeader +
      • +
    • KafkaProducer

    -

    Properties

    -
    - -

    hasRack

    -
    hasRack: boolean
    - -
    -
    -

    Set if this node has a defined rack

    -
    -
    -
    param
    -

    if this node has a defined rack

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Node

      +
      • +
    • + +

      Parameters

      + +

      Returns Node

      +
      • +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the host name for this node

    -
    -
    -
    param
    -

    the host name for this node

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the host name for this node

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    id

    -
    id: number
    - -
    -
    -

    Set the node id of this node

    -
    -
    -
    param
    -

    the node id of this node

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getId

    +
      +
    • getId(): number
      • +
    +
      +
    • + +
      +
      +

      Set the node id of this node

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    idString

    -
    idString: string
    - -
    -
    -

    Set the string representation of the node id

    -
    -
    -
    param
    -

    String representation of the node id

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getIdString

    +
      +
    • getIdString(): string
      • +
    +
      +
    • + +
      +
      +

      Set the string representation of the node id

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port for this node

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    hasRack

    +
      +
    • hasRack(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set if this node has a defined rack

      +
      +
      +

      Returns boolean

      +

      current instance of the class to be fluent

      +
      • +
    -
    +

    isEmpty

    -
    isEmpty: boolean
    - -
    -
    -

    Set if this node is empty

    -
    -
    -
    param
    -

    if this node is empty

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    -
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port for this node

    -
    -
    -
    param
    -

    the port for this node

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
      +
    • isEmpty(): boolean
      • +
    • isEmpty(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      if this node is empty, which may be the case if noNode() is used as a placeholder in a response payload with an error

      +
      • +
    • + +
      +
      +

      Set if this node is empty

      +
      +
      +

      Returns boolean

      +

      current instance of the class to be fluent

      +
      • +
    -
    +

    rack

    -
    rack: string
    - -
    -
    -

    Set the rack for this node

    -
    -
    -
    param
    -

    the rack for this node

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
      +
    • rack(): string
      • +
    +
      +
    • + +
      +
      +

      Set the rack for this node

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setHasRack

    +
      +
    • setHasRack(hasRack: boolean): Node
      • +
    +
      +
    • + +
      +
      +

      Set if this node has a defined rack

      +
      +
      +

      Parameters

      +
        +
      • +
        hasRack: boolean
        +
        +

        if this node has a defined rack

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setHost

    +
      +
    • setHost(host: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set the host name for this node

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the host name for this node

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setId

    +
      +
    • setId(id: number): Node
      • +
    +
      +
    • + +
      +
      +

      Set the node id of this node

      +
      +
      +

      Parameters

      +
        +
      • +
        id: number
        +
        +

        the node id of this node

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setIdString

    +
      +
    • setIdString(idString: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set the string representation of the node id

      +
      +
      +

      Parameters

      +
        +
      • +
        idString: string
        +
        +

        String representation of the node id

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setIsEmpty

    +
      +
    • setIsEmpty(isEmpty: boolean): Node
      • +
    +
      +
    • + +
      +
      +

      Set if this node is empty

      +
      +
      +

      Parameters

      +
        +
      • +
        isEmpty: boolean
        +
        +

        if this node is empty

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setPort

    +
      +
    • setPort(port: number): Node
      • +
    +
      +
    • + +
      +
      +

      Set the port for this node

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port for this node

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setRack

    +
      +
    • setRack(rack: string): Node
      • +
    +
      +
    • + +
      +
      +

      Set the rack for this node

      +
      +
      +

      Parameters

      +
        +
      • +
        rack: string
        +
        +

        the rack for this node

        +
        +
        • +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    @@ -269,19 +553,22 @@

    rack

  • AdminUtils
    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
    • -
  • +
  • KafkaConsumerRecords
  • + KafkaHeader +
    • +
  • KafkaProducer
    • -
  • +
  • KafkaProducerRecord
    • @@ -289,27 +576,51 @@

    rack

  • Node
    • diff --git a/docs/@vertx/kafka-client/classes/offsetandmetadata.html b/docs/@vertx/kafka-client/classes/offsetandmetadata.html index 479a75707..48dac2c8a 100644 --- a/docs/@vertx/kafka-client/classes/offsetandmetadata.html +++ b/docs/@vertx/kafka-client/classes/offsetandmetadata.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    metadata

    -
    metadata: string
    - -
    -
    -

    Set additional metadata for the offset committed

    -
    -
    -
    param
    -

    additional metadata

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    offset

    -
    offset: number
    - -
    -
    -

    Set the offset to commit

    -
    -
    -
    param
    -

    offset to commit

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getMetadata

    +
      +
    • getMetadata(): string
      • +
    +
      +
    • + +
      +
      +

      Set additional metadata for the offset committed

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    getOffset

    +
      +
    • getOffset(): number
      • +
    +
      +
    • + +
      +
      +

      Set the offset to commit

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setMetadata

    + +
      +
    • + +
      +
      +

      Set additional metadata for the offset committed

      +
      +
      +

      Parameters

      +
        +
      • +
        metadata: string
        +
        +

        additional metadata

        +
        +
        • +
      +

      Returns OffsetAndMetadata

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setOffset

    + +
      +
    • + +
      +
      +

      Set the offset to commit

      +
      +
      +

      Parameters

      +
        +
      • +
        offset: number
        +
        +

        offset to commit

        +
        +
        • +
      +

      Returns OffsetAndMetadata

      +

      current instance of the class to be fluent

      +
      • +
    @@ -149,19 +256,22 @@

    offset

  • AdminUtils
    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
    • -
  • +
  • KafkaConsumerRecords
  • + KafkaHeader +
    • +
  • KafkaProducer
    • -
  • +
  • KafkaProducerRecord
  • @@ -172,11 +282,20 @@

    offset

  • OffsetAndMetadata
    • diff --git a/docs/@vertx/kafka-client/classes/offsetandtimestamp.html b/docs/@vertx/kafka-client/classes/offsetandtimestamp.html index 51c60120d..5610105fc 100644 --- a/docs/@vertx/kafka-client/classes/offsetandtimestamp.html +++ b/docs/@vertx/kafka-client/classes/offsetandtimestamp.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    offset

    -
    offset: number
    - -
    -
    -

    Set the offset

    -
    -
    -
    param
    -

    the offset

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    timestamp

    -
    timestamp: number
    - -
    -
    -

    Set the timestamp

    -
    -
    -
    param
    -

    the timestamp

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getOffset

    +
      +
    • getOffset(): number
      • +
    +
      +
    • + +
      +
      +

      Set the offset

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    getTimestamp

    +
      +
    • getTimestamp(): number
      • +
    +
      +
    • + +
      +
      +

      Set the timestamp

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setOffset

    + +
      +
    • + +
      +
      +

      Set the offset

      +
      +
      +

      Parameters

      +
        +
      • +
        offset: number
        +
        +

        the offset

        +
        +
        • +
      +

      Returns OffsetAndTimestamp

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setTimestamp

    + +
      +
    • + +
      +
      +

      Set the timestamp

      +
      +
      +

      Parameters

      +
        +
      • +
        timestamp: number
        +
        +

        the timestamp

        +
        +
        • +
      +

      Returns OffsetAndTimestamp

      +

      current instance of the class to be fluent

      +
      • +
    @@ -149,19 +256,22 @@

    timestamp

  • AdminUtils
    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
    • -
  • +
  • KafkaConsumerRecords
  • + KafkaHeader +
    • +
  • KafkaProducer
    • -
  • +
  • KafkaProducerRecord
  • @@ -175,11 +285,20 @@

    timestamp

  • OffsetAndTimestamp
    • diff --git a/docs/@vertx/kafka-client/classes/partitioninfo.html b/docs/@vertx/kafka-client/classes/partitioninfo.html index b442ebaf7..8a8818df9 100644 --- a/docs/@vertx/kafka-client/classes/partitioninfo.html +++ b/docs/@vertx/kafka-client/classes/partitioninfo.html @@ -77,134 +77,340 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    inSyncReplicas

    -
    inSyncReplicas: Node
    - -
    -
    -

    Set the subset of the replicas that are in sync

    -
    -
    -
    param
    -

    the subset of the replicas that are in sync

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    leader

    -
    leader: Node
    - -
    -
    -

    Set the node id of the node currently acting as a leader

    -
    -
    -
    param
    -

    the node id of the node currently acting as a leader

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getInSyncReplicas

    +
      +
    • getInSyncReplicas(): Node
      • +
    +
      +
    • + +
      +
      +

      Set the subset of the replicas that are in sync

      +
      +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    partition

    -
    partition: number
    - -
    -
    -

    Set the partition id

    -
    -
    -
    param
    -

    the partition id

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getLeader

    +
      +
    • getLeader(): Node
      • +
    +
      +
    • + +
      +
      +

      Set the node id of the node currently acting as a leader

      +
      +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    replicas

    -
    replicas: Node
    - -
    -
    -

    Set the complete set of replicas for this partition

    -
    -
    -
    param
    -

    the complete set of replicas for this partition

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getPartition

    +
      +
    • getPartition(): number
      • +
    +
      +
    • + +
      +
      +

      Set the partition id

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    topic

    -
    topic: string
    - -
    -
    -

    Set the topic name

    -
    -
    -
    param
    -

    the topic name

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getReplicas

    +
      +
    • getReplicas(): Node
      • +
    +
      +
    • + +
      +
      +

      Set the complete set of replicas for this partition

      +
      +
      +

      Returns Node

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    getTopic

    +
      +
    • getTopic(): string
      • +
    +
      +
    • + +
      +
      +

      Set the topic name

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setInSyncReplicas

    + +
      +
    • + +
      +
      +

      Set the subset of the replicas that are in sync

      +
      +
      +

      Parameters

      +
        +
      • +
        inSyncReplicas: Node
        +
        +

        the subset of the replicas that are in sync

        +
        +
        • +
      +

      Returns PartitionInfo

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setLeader

    + +
      +
    • + +
      +
      +

      Set the node id of the node currently acting as a leader

      +
      +
      +

      Parameters

      +
        +
      • +
        leader: Node
        +
        +

        the node id of the node currently acting as a leader

        +
        +
        • +
      +

      Returns PartitionInfo

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setPartition

    + +
      +
    • + +
      +
      +

      Set the partition id

      +
      +
      +

      Parameters

      +
        +
      • +
        partition: number
        +
        +

        the partition id

        +
        +
        • +
      +

      Returns PartitionInfo

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setReplicas

    + +
      +
    • + +
      +
      +

      Set the complete set of replicas for this partition

      +
      +
      +

      Parameters

      +
        +
      • +
        replicas: Node
        +
        +

        the complete set of replicas for this partition

        +
        +
        • +
      +

      Returns PartitionInfo

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setTopic

    + +
      +
    • + +
      +
      +

      Set the topic name

      +
      +
      +

      Parameters

      +
        +
      • +
        topic: string
        +
        +

        the topic name

        +
        +
        • +
      +

      Returns PartitionInfo

      +

      current instance of the class to be fluent

      +
      • +
    @@ -221,19 +427,22 @@

    topic

  • AdminUtils
    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
    • -
  • +
  • KafkaConsumerRecords
  • + KafkaHeader +
    • +
  • KafkaProducer
    • -
  • +
  • KafkaProducerRecord
  • @@ -250,20 +459,38 @@

    topic

  • PartitionInfo
    • diff --git a/docs/@vertx/kafka-client/classes/recordmetadata.html b/docs/@vertx/kafka-client/classes/recordmetadata.html index dd2f5cabc..258c4e715 100644 --- a/docs/@vertx/kafka-client/classes/recordmetadata.html +++ b/docs/@vertx/kafka-client/classes/recordmetadata.html @@ -77,134 +77,340 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +

    checksum

    -
    checksum: number
    - -
    -
    -

    Set the checksum (CRC32) of the record.

    -
    -
    -
    param
    -

    checksum (CRC32) of the record

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
      +
    • checksum(): number
      • +
    +
      +
    • + +
      +
      +

      Set the checksum (CRC32) of the record.

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    offset

    -
    offset: number
    - -
    -
    -

    Set the offset of the record in the topic/partition.

    -
    -
    -
    param
    -

    offset of the record in the topic/partition

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getOffset

    +
      +
    • getOffset(): number
      • +
    +
      +
    • + +
      +
      +

      Set the offset of the record in the topic/partition.

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    partition

    -
    partition: number
    - -
    -
    -

    Set the partition the record was sent to

    -
    -
    -
    param
    -

    the partition the record was sent to

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getPartition

    +
      +
    • getPartition(): number
      • +
    +
      +
    • + +
      +
      +

      Set the partition the record was sent to

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    timestamp

    -
    timestamp: number
    - -
    -
    -

    Set the timestamp of the record in the topic/partition

    -
    -
    -
    param
    -

    the timestamp of the record in the topic/partition

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getTimestamp

    +
      +
    • getTimestamp(): number
      • +
    +
      +
    • + +
      +
      +

      Set the timestamp of the record in the topic/partition

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    -
    - -

    topic

    -
    topic: string
    - -
    -
    -

    Set the topic the record was appended to

    -
    -
    -
    param
    -

    the topic the record was appended to

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    + +

    getTopic

    +
      +
    • getTopic(): string
      • +
    +
      +
    • + +
      +
      +

      Set the topic the record was appended to

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setChecksum

    + +
      +
    • + +
      +
      +

      Set the checksum (CRC32) of the record.

      +
      +
      +

      Parameters

      +
        +
      • +
        checksum: number
        +
        +

        checksum (CRC32) of the record

        +
        +
        • +
      +

      Returns RecordMetadata

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setOffset

    + +
      +
    • + +
      +
      +

      Set the offset of the record in the topic/partition.

      +
      +
      +

      Parameters

      +
        +
      • +
        offset: number
        +
        +

        offset of the record in the topic/partition

        +
        +
        • +
      +

      Returns RecordMetadata

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setPartition

    + +
      +
    • + +
      +
      +

      Set the partition the record was sent to

      +
      +
      +

      Parameters

      +
        +
      • +
        partition: number
        +
        +

        the partition the record was sent to

        +
        +
        • +
      +

      Returns RecordMetadata

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setTimestamp

    + +
      +
    • + +
      +
      +

      Set the timestamp of the record in the topic/partition

      +
      +
      +

      Parameters

      +
        +
      • +
        timestamp: number
        +
        +

        the timestamp of the record in the topic/partition

        +
        +
        • +
      +

      Returns RecordMetadata

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setTopic

    + +
      +
    • + +
      +
      +

      Set the topic the record was appended to

      +
      +
      +

      Parameters

      +
        +
      • +
        topic: string
        +
        +

        the topic the record was appended to

        +
        +
        • +
      +

      Returns RecordMetadata

      +

      current instance of the class to be fluent

      +
      • +
    @@ -221,19 +427,22 @@

    topic

  • AdminUtils
    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
    • -
  • +
  • KafkaConsumerRecords
  • + KafkaHeader +
    • +
  • KafkaProducer
    • -
  • +
  • KafkaProducerRecord
  • @@ -253,20 +462,38 @@

    topic

  • RecordMetadata
    • diff --git a/docs/@vertx/kafka-client/classes/topicpartition.html b/docs/@vertx/kafka-client/classes/topicpartition.html index ee2a126ed..de35d1c20 100644 --- a/docs/@vertx/kafka-client/classes/topicpartition.html +++ b/docs/@vertx/kafka-client/classes/topicpartition.html @@ -77,62 +77,169 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    partition

    -
    partition: number
    - -
    -
    -

    Set the partition number

    -
    -
    -
    param
    -

    the partition number

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    topic

    -
    topic: string
    - -
    -
    -

    Set the topic name

    -
    -
    -
    param
    -

    the topic name

    -
    -
    returns
    -

    current instance of the class to be fluent

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getPartition

    +
      +
    • getPartition(): number
      • +
    +
      +
    • + +
      +
      +

      Set the partition number

      +
      +
      +

      Returns number

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    getTopic

    +
      +
    • getTopic(): string
      • +
    +
      +
    • + +
      +
      +

      Set the topic name

      +
      +
      +

      Returns string

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setPartition

    + +
      +
    • + +
      +
      +

      Set the partition number

      +
      +
      +

      Parameters

      +
        +
      • +
        partition: number
        +
        +

        the partition number

        +
        +
        • +
      +

      Returns TopicPartition

      +

      current instance of the class to be fluent

      +
      • +
    +
    +
    + +

    setTopic

    + +
      +
    • + +
      +
      +

      Set the topic name

      +
      +
      +

      Parameters

      +
        +
      • +
        topic: string
        +
        +

        the topic name

        +
        +
        • +
      +

      Returns TopicPartition

      +

      current instance of the class to be fluent

      +
      • +
    @@ -149,19 +256,22 @@

    topic

  • AdminUtils
    • -
  • +
  • KafkaConsumer
    • -
  • +
  • KafkaConsumerRecord
    • -
  • +
  • KafkaConsumerRecords
  • + KafkaHeader +
    • +
  • KafkaProducer
    • -
  • +
  • KafkaProducerRecord
  • @@ -184,11 +294,20 @@

    topic

  • TopicPartition
    • diff --git a/docs/@vertx/kafka-client/globals.html b/docs/@vertx/kafka-client/globals.html index 8e4eab54b..5bc284f1b 100644 --- a/docs/@vertx/kafka-client/globals.html +++ b/docs/@vertx/kafka-client/globals.html @@ -69,11 +69,12 @@

    Index

    Classes

    • AdminUtils
      • -
    • KafkaConsumer
      • -
    • KafkaConsumerRecord
      • -
    • KafkaConsumerRecords
      • -
    • KafkaProducer
      • -
    • KafkaProducerRecord
      • +
    • KafkaConsumer
      • +
    • KafkaConsumerRecord
      • +
    • KafkaConsumerRecords
      • +
    • KafkaHeader
      • +
    • KafkaProducer
      • +
    • KafkaProducerRecord
    • Node
    • OffsetAndMetadata
    • OffsetAndTimestamp
      • @@ -99,19 +100,22 @@

      Classes

    • AdminUtils
      • -
    • +
    • KafkaConsumer
      • -
    • +
    • KafkaConsumerRecord
      • -
    • +
    • KafkaConsumerRecords
    • + KafkaHeader +
      • +
    • KafkaProducer
      • -
    • +
    • KafkaProducerRecord
    • diff --git a/docs/@vertx/kafka-client/index.html b/docs/@vertx/kafka-client/index.html index e67eb3461..cea3531a1 100644 --- a/docs/@vertx/kafka-client/index.html +++ b/docs/@vertx/kafka-client/index.html @@ -110,19 +110,22 @@
    • AdminUtils
      • -
    • +
    • KafkaConsumer
      • -
    • +
    • KafkaConsumerRecord
      • -
    • +
    • KafkaConsumerRecords
    • + KafkaHeader +
      • +
    • KafkaProducer
      • -
    • +
    • KafkaProducerRecord
    • diff --git a/docs/@vertx/mail-client/assets/js/search.js b/docs/@vertx/mail-client/assets/js/search.js index 0924bddc8..678490fa2 100644 --- a/docs/@vertx/mail-client/assets/js/search.js +++ b/docs/@vertx/mail-client/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"MailAttachment","url":"classes/mailattachment.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"contentId","url":"classes/mailattachment.html#contentid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":2,"kind":1024,"name":"contentType","url":"classes/mailattachment.html#contenttype","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":3,"kind":1024,"name":"data","url":"classes/mailattachment.html#data","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":4,"kind":1024,"name":"description","url":"classes/mailattachment.html#description","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":5,"kind":1024,"name":"disposition","url":"classes/mailattachment.html#disposition","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":6,"kind":1024,"name":"headers","url":"classes/mailattachment.html#headers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":7,"kind":1024,"name":"name","url":"classes/mailattachment.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailAttachment"},{"id":8,"kind":128,"name":"MailConfig","url":"classes/mailconfig.html","classes":"tsd-kind-class"},{"id":9,"kind":1024,"name":"allowRcptErrors","url":"classes/mailconfig.html#allowrcpterrors","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":10,"kind":1024,"name":"authMethods","url":"classes/mailconfig.html#authmethods","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":11,"kind":1024,"name":"disableEsmtp","url":"classes/mailconfig.html#disableesmtp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":12,"kind":1024,"name":"hostname","url":"classes/mailconfig.html#hostname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":13,"kind":1024,"name":"keepAlive","url":"classes/mailconfig.html#keepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":14,"kind":1024,"name":"keyStore","url":"classes/mailconfig.html#keystore","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":15,"kind":1024,"name":"keyStorePassword","url":"classes/mailconfig.html#keystorepassword","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":16,"kind":1024,"name":"login","url":"classes/mailconfig.html#login","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":17,"kind":1024,"name":"maxPoolSize","url":"classes/mailconfig.html#maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":18,"kind":1024,"name":"ownHostname","url":"classes/mailconfig.html#ownhostname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":19,"kind":1024,"name":"password","url":"classes/mailconfig.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":20,"kind":1024,"name":"port","url":"classes/mailconfig.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":21,"kind":1024,"name":"ssl","url":"classes/mailconfig.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":22,"kind":1024,"name":"starttls","url":"classes/mailconfig.html#starttls","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":23,"kind":1024,"name":"trustAll","url":"classes/mailconfig.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":24,"kind":1024,"name":"username","url":"classes/mailconfig.html#username","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailConfig"},{"id":25,"kind":128,"name":"MailMessage","url":"classes/mailmessage.html","classes":"tsd-kind-class"},{"id":26,"kind":1024,"name":"attachment","url":"classes/mailmessage.html#attachment","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":27,"kind":1024,"name":"bcc","url":"classes/mailmessage.html#bcc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":28,"kind":1024,"name":"bounceAddress","url":"classes/mailmessage.html#bounceaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":29,"kind":1024,"name":"cc","url":"classes/mailmessage.html#cc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":30,"kind":1024,"name":"fixedHeaders","url":"classes/mailmessage.html#fixedheaders","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":31,"kind":1024,"name":"from","url":"classes/mailmessage.html#from","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":32,"kind":1024,"name":"headers","url":"classes/mailmessage.html#headers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":33,"kind":1024,"name":"html","url":"classes/mailmessage.html#html","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":34,"kind":1024,"name":"inlineAttachment","url":"classes/mailmessage.html#inlineattachment","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":35,"kind":1024,"name":"subject","url":"classes/mailmessage.html#subject","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":36,"kind":1024,"name":"text","url":"classes/mailmessage.html#text","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":37,"kind":1024,"name":"to","url":"classes/mailmessage.html#to","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailMessage"},{"id":38,"kind":128,"name":"MailResult","url":"classes/mailresult.html","classes":"tsd-kind-class"},{"id":39,"kind":1024,"name":"messageID","url":"classes/mailresult.html#messageid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailResult"},{"id":40,"kind":1024,"name":"recipients","url":"classes/mailresult.html#recipients","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MailResult"},{"id":41,"kind":128,"name":"MailClient","url":"classes/mailclient.html","classes":"tsd-kind-class"},{"id":42,"kind":2048,"name":"createNonShared","url":"classes/mailclient.html#createnonshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MailClient"},{"id":43,"kind":2048,"name":"createShared","url":"classes/mailclient.html#createshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MailClient"},{"id":44,"kind":2048,"name":"sendMail","url":"classes/mailclient.html#sendmail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailClient"},{"id":45,"kind":2048,"name":"close","url":"classes/mailclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailClient"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"MailAttachment","url":"classes/mailattachment.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/mailattachment.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MailAttachment"},{"id":2,"kind":2048,"name":"getContentId","url":"classes/mailattachment.html#getcontentid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":3,"kind":2048,"name":"setContentId","url":"classes/mailattachment.html#setcontentid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":4,"kind":2048,"name":"getContentType","url":"classes/mailattachment.html#getcontenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":5,"kind":2048,"name":"setContentType","url":"classes/mailattachment.html#setcontenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":6,"kind":2048,"name":"getData","url":"classes/mailattachment.html#getdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":7,"kind":2048,"name":"setData","url":"classes/mailattachment.html#setdata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":8,"kind":2048,"name":"getDescription","url":"classes/mailattachment.html#getdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":9,"kind":2048,"name":"setDescription","url":"classes/mailattachment.html#setdescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":10,"kind":2048,"name":"getDisposition","url":"classes/mailattachment.html#getdisposition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":11,"kind":2048,"name":"setDisposition","url":"classes/mailattachment.html#setdisposition","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":12,"kind":2048,"name":"headers","url":"classes/mailattachment.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":13,"kind":2048,"name":"addHeader","url":"classes/mailattachment.html#addheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":14,"kind":2048,"name":"getName","url":"classes/mailattachment.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":15,"kind":2048,"name":"setName","url":"classes/mailattachment.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailAttachment"},{"id":16,"kind":128,"name":"MailConfig","url":"classes/mailconfig.html","classes":"tsd-kind-class"},{"id":17,"kind":512,"name":"constructor","url":"classes/mailconfig.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MailConfig"},{"id":18,"kind":2048,"name":"isAllowRcptErrors","url":"classes/mailconfig.html#isallowrcpterrors","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":19,"kind":2048,"name":"setAllowRcptErrors","url":"classes/mailconfig.html#setallowrcpterrors","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":20,"kind":2048,"name":"getAuthMethods","url":"classes/mailconfig.html#getauthmethods","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":21,"kind":2048,"name":"setAuthMethods","url":"classes/mailconfig.html#setauthmethods","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":22,"kind":2048,"name":"isDisableEsmtp","url":"classes/mailconfig.html#isdisableesmtp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":23,"kind":2048,"name":"setDisableEsmtp","url":"classes/mailconfig.html#setdisableesmtp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":24,"kind":2048,"name":"getHostname","url":"classes/mailconfig.html#gethostname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":25,"kind":2048,"name":"setHostname","url":"classes/mailconfig.html#sethostname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":26,"kind":2048,"name":"isKeepAlive","url":"classes/mailconfig.html#iskeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":27,"kind":2048,"name":"setKeepAlive","url":"classes/mailconfig.html#setkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":28,"kind":2048,"name":"getKeyStore","url":"classes/mailconfig.html#getkeystore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":29,"kind":2048,"name":"setKeyStore","url":"classes/mailconfig.html#setkeystore","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":30,"kind":2048,"name":"getKeyStorePassword","url":"classes/mailconfig.html#getkeystorepassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":31,"kind":2048,"name":"setKeyStorePassword","url":"classes/mailconfig.html#setkeystorepassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":32,"kind":2048,"name":"getLogin","url":"classes/mailconfig.html#getlogin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":33,"kind":2048,"name":"setLogin","url":"classes/mailconfig.html#setlogin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":34,"kind":2048,"name":"getMaxPoolSize","url":"classes/mailconfig.html#getmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":35,"kind":2048,"name":"setMaxPoolSize","url":"classes/mailconfig.html#setmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":36,"kind":2048,"name":"getOwnHostname","url":"classes/mailconfig.html#getownhostname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":37,"kind":2048,"name":"setOwnHostname","url":"classes/mailconfig.html#setownhostname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":38,"kind":2048,"name":"getPassword","url":"classes/mailconfig.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":39,"kind":2048,"name":"setPassword","url":"classes/mailconfig.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":40,"kind":2048,"name":"getPort","url":"classes/mailconfig.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":41,"kind":2048,"name":"setPort","url":"classes/mailconfig.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":42,"kind":2048,"name":"isSsl","url":"classes/mailconfig.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":43,"kind":2048,"name":"setSsl","url":"classes/mailconfig.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":44,"kind":2048,"name":"getStarttls","url":"classes/mailconfig.html#getstarttls","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":45,"kind":2048,"name":"setStarttls","url":"classes/mailconfig.html#setstarttls","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":46,"kind":2048,"name":"isTrustAll","url":"classes/mailconfig.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":47,"kind":2048,"name":"setTrustAll","url":"classes/mailconfig.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":48,"kind":2048,"name":"getUsername","url":"classes/mailconfig.html#getusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":49,"kind":2048,"name":"setUsername","url":"classes/mailconfig.html#setusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailConfig"},{"id":50,"kind":128,"name":"MailMessage","url":"classes/mailmessage.html","classes":"tsd-kind-class"},{"id":51,"kind":512,"name":"constructor","url":"classes/mailmessage.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MailMessage"},{"id":52,"kind":2048,"name":"getAttachment","url":"classes/mailmessage.html#getattachment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":53,"kind":2048,"name":"setAttachment","url":"classes/mailmessage.html#setattachment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":54,"kind":2048,"name":"getBcc","url":"classes/mailmessage.html#getbcc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":55,"kind":2048,"name":"setBcc","url":"classes/mailmessage.html#setbcc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":56,"kind":2048,"name":"getBounceAddress","url":"classes/mailmessage.html#getbounceaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":57,"kind":2048,"name":"setBounceAddress","url":"classes/mailmessage.html#setbounceaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":58,"kind":2048,"name":"getCc","url":"classes/mailmessage.html#getcc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":59,"kind":2048,"name":"setCc","url":"classes/mailmessage.html#setcc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":60,"kind":2048,"name":"isFixedHeaders","url":"classes/mailmessage.html#isfixedheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":61,"kind":2048,"name":"setFixedHeaders","url":"classes/mailmessage.html#setfixedheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":62,"kind":2048,"name":"getFrom","url":"classes/mailmessage.html#getfrom","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":63,"kind":2048,"name":"setFrom","url":"classes/mailmessage.html#setfrom","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":64,"kind":2048,"name":"headers","url":"classes/mailmessage.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":65,"kind":2048,"name":"addHeader","url":"classes/mailmessage.html#addheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":66,"kind":2048,"name":"getHtml","url":"classes/mailmessage.html#gethtml","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":67,"kind":2048,"name":"setHtml","url":"classes/mailmessage.html#sethtml","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":68,"kind":2048,"name":"getInlineAttachment","url":"classes/mailmessage.html#getinlineattachment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":69,"kind":2048,"name":"setInlineAttachment","url":"classes/mailmessage.html#setinlineattachment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":70,"kind":2048,"name":"getSubject","url":"classes/mailmessage.html#getsubject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":71,"kind":2048,"name":"setSubject","url":"classes/mailmessage.html#setsubject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":72,"kind":2048,"name":"getText","url":"classes/mailmessage.html#gettext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":73,"kind":2048,"name":"setText","url":"classes/mailmessage.html#settext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":74,"kind":2048,"name":"getTo","url":"classes/mailmessage.html#getto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":75,"kind":2048,"name":"setTo","url":"classes/mailmessage.html#setto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailMessage"},{"id":76,"kind":128,"name":"MailResult","url":"classes/mailresult.html","classes":"tsd-kind-class"},{"id":77,"kind":512,"name":"constructor","url":"classes/mailresult.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MailResult"},{"id":78,"kind":2048,"name":"getMessageID","url":"classes/mailresult.html#getmessageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailResult"},{"id":79,"kind":2048,"name":"setMessageID","url":"classes/mailresult.html#setmessageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailResult"},{"id":80,"kind":2048,"name":"getRecipients","url":"classes/mailresult.html#getrecipients","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailResult"},{"id":81,"kind":2048,"name":"setRecipients","url":"classes/mailresult.html#setrecipients","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailResult"},{"id":82,"kind":128,"name":"MailClient","url":"classes/mailclient.html","classes":"tsd-kind-class"},{"id":83,"kind":2048,"name":"createNonShared","url":"classes/mailclient.html#createnonshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MailClient"},{"id":84,"kind":2048,"name":"createShared","url":"classes/mailclient.html#createshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MailClient"},{"id":85,"kind":2048,"name":"sendMail","url":"classes/mailclient.html#sendmail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailClient"},{"id":86,"kind":2048,"name":"close","url":"classes/mailclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MailClient"}]}; \ No newline at end of file diff --git a/docs/@vertx/mail-client/classes/mailattachment.html b/docs/@vertx/mail-client/classes/mailattachment.html index df3d87bb2..cc4c47997 100644 --- a/docs/@vertx/mail-client/classes/mailattachment.html +++ b/docs/@vertx/mail-client/classes/mailattachment.html @@ -77,189 +77,459 @@

      Index

      -

      Properties

      +

      Constructors

      +
      +
      +

      Methods

      +
    -

    Properties

    -
    - -

    contentId

    -
    contentId: string
    - -
    -
    -

    set the Content-ID field to be used in the attachment

    -
    -
    -
    param
    -

    the content id

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    contentType

    -
    contentType: string
    - -
    -
    -

    set the Content-Type

    -
    -
    -
    param
    -

    the contentType

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addHeader

    + +
      +
    • + +
      +
      +

      Add an header to this attachment.

      +
      +
      +

      Parameters

      +
        +
      • +
        headers: string
        +
        • +
      +

      Returns MailAttachment

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    data

    -
    data: Buffer
    - -
    -
    -

    set the data

    -
    -
    -
    param
    -

    Buffer of bytes to be used at attachment

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getContentId

    +
      +
    • getContentId(): string
      • +
    +
      +
    • + +
      +
      +

      set the Content-ID field to be used in the attachment

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    description

    -
    description: string
    - -
    -
    -

    set the description field to be used in the attachment

    -
    -
    -
    param
    -

    the description

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getContentType

    +
      +
    • getContentType(): string
      • +
    +
      +
    • + +
      +
      +

      set the Content-Type

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    disposition

    -
    disposition: string
    - -
    -
    -

    set the disposition field to be used in the attachment

    -
    -
    -
    param
    -

    the disposition

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getData

    +
      +
    • getData(): Buffer
      • +
    +
      +
    • + +
      +
      +

      set the data

      +
      +
      +

      Returns Buffer

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getDescription

    +
      +
    • getDescription(): string
      • +
    +
      +
    • + +
      +
      +

      set the description field to be used in the attachment

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getDisposition

    +
      +
    • getDisposition(): string
      • +
    +
      +
    • + +
      +
      +

      set the disposition field to be used in the attachment

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      set the name

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently +

      + name is the descriptive filename that will be put into the mail + i.e. usually a local filename without path + this can be set to "" to omit the filename attribute

      +
      • +
    -
    +

    headers

    -
    headers: string
    - -
    -
    -

    Add an header to this attachment.

    -
    -
    -
    param
    -

    the header key

    -
    -
    param
    -

    the header value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • headers(): string
      • +
    +
      +
    • + +
      +
      +

      Add an header to this attachment.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    set the name

    -
    -
    -
    param
    -

    name of the attachment file

    -
    -
    returns
    -

    this to be able to use it fluently -

    - name is the descriptive filename that will be put into the mail - i.e. usually a local filename without path - this can be set to "" to omit the filename attribute

    -
    -
    -
    +
    + +

    setContentId

    + +
      +
    • + +
      +
      +

      set the Content-ID field to be used in the attachment

      +
      +
      +

      Parameters

      +
        +
      • +
        contentId: string
        +
        +

        the content id

        +
        +
        • +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setContentType

    + +
      +
    • + +
      +
      +

      set the Content-Type

      +
      +
      +

      Parameters

      +
        +
      • +
        contentType: string
        +
        +

        the contentType

        +
        +
        • +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setData

    + +
      +
    • + +
      +
      +

      set the data

      +
      +
      +

      Parameters

      +
        +
      • +
        data: Buffer
        +
        +

        Buffer of bytes to be used at attachment

        +
        +
        • +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setDescription

    + +
      +
    • + +
      +
      +

      set the description field to be used in the attachment

      +
      +
      +

      Parameters

      +
        +
      • +
        description: string
        +
        +

        the description

        +
        +
        • +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setDisposition

    + +
      +
    • + +
      +
      +

      set the disposition field to be used in the attachment

      +
      +
      +

      Parameters

      +
        +
      • +
        disposition: string
        +
        +

        the disposition

        +
        +
        • +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      set the name

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of the attachment file

        +
        +
        • +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently +

      + name is the descriptive filename that will be put into the mail + i.e. usually a local filename without path + this can be set to "" to omit the filename attribute

      +
      • +
    @@ -278,26 +548,50 @@

    name

  • MailAttachment
    • diff --git a/docs/@vertx/mail-client/classes/mailclient.html b/docs/@vertx/mail-client/classes/mailclient.html index 592f1fff7..0ab3b5778 100644 --- a/docs/@vertx/mail-client/classes/mailclient.html +++ b/docs/@vertx/mail-client/classes/mailclient.html @@ -100,12 +100,12 @@

    close

  • -

    close the MailClient

    +

    close the MailClient

    Returns void

    @@ -122,12 +122,12 @@

    sendMail

  • -

    send a single mail via MailClient

    +

    send a single mail via MailClient

    Parameters

    @@ -147,17 +147,20 @@
    resultHandler: function
    • -

    Properties

    -
    - -

    allowRcptErrors

    -
    allowRcptErrors: boolean
    - -
    -
    -

    set if sending allows rcpt errors -

    - if true, the mail will be sent to the recipients that the server accepted, if any -

    -
    -
    -
    param
    -

    the allowRcptErrors to set (default is false)

    -
    -
    returns
    -

    this to be able to use the object fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns MailConfig

      +
      • +
    • + +

      Parameters

      + +

      Returns MailConfig

      +
      • +
    -
    - -

    authMethods

    -
    authMethods: string
    - -
    -
    -

    set string of allowed auth methods. - if set only these methods will be used - if the server supports them. If null or empty all supported methods may be - used

    -
    -
    -
    param
    -

    the authMethods to set

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAuthMethods

    +
      +
    • getAuthMethods(): string
      • +
    +
      +
    • + +
      +
      +

      set string of allowed auth methods. + if set only these methods will be used + if the server supports them. If null or empty all supported methods may be + used

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    disableEsmtp

    -
    disableEsmtp: boolean
    - -
    -
    -

    set if ESMTP should be tried as first command (EHLO) -

    - rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP - is supported, if this returns an error code, HELO is tried to use old SMTP. - If there is a server that does not support EHLO and does not give an error code back, the connection - should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a - setting. The odds of this actually happening are very small since the client will not connect to arbitrary - smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO - in that way, the property has to be set to false. -

    -
    -
    -
    param
    -

    the disableEsmtp to set (default is true)

    -
    -
    returns
    -

    this to be able to use the object fluently

    -
    -
    -
    +
    + +

    getHostname

    +
      +
    • getHostname(): string
      • +
    +
      +
    • + +
      +
      +

      Set the hostname of the smtp server.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    hostname

    -
    hostname: string
    - -
    -
    -

    Set the hostname of the smtp server.

    -
    -
    -
    param
    -

    the hostname (default is localhost)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getKeyStore

    +
      +
    • getKeyStore(): string
      • +
    +
      +
    • + +
      +
      +

      get the key store filename to be used when opening SMTP connections +

      + if not set, an options object will be created based on other settings (ssl + and trustAll)

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keepAlive

    -
    keepAlive: boolean
    - -
    -
    -

    set if connection pool is enabled - default is true -

    - if the connection pooling is disabled, the max number of sockets is enforced nevertheless -

    -
    -
    -
    returns
    -

    this to be able to use the object fluently

    -
    -
    -
    +
    + +

    getKeyStorePassword

    +
      +
    • getKeyStorePassword(): string
      • +
    +
      +
    • + +
      +
      +

      get the key store password to be used when opening SMTP connections

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyStore

    -
    keyStore: string
    - -
    -
    -

    get the key store filename to be used when opening SMTP connections -

    - if not set, an options object will be created based on other settings (ssl - and trustAll)

    -
    -
    -
    param
    -

    the key store filename to be set

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getLogin

    +
      +
    • getLogin(): LoginOption
      • +
    +
      +
    • + +
      +
      +

      Set the login mode for the connection. +

      + Either DISABLED, OPTIONAL or REQUIRED

      +
      +
      +

      Returns LoginOption

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    keyStorePassword

    -
    keyStorePassword: string
    - -
    -
    -

    get the key store password to be used when opening SMTP connections

    -
    -
    -
    param
    -

    the key store passwords to be set

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getMaxPoolSize

    +
      +
    • getMaxPoolSize(): number
      • +
    +
      +
    • + +
      +
      +

      set the max allowed number of open connections to the mail server + if not set the default is 10

      +
      +
      +

      Returns number

      +

      this to be able to use the object fluently

      +
      • +
    -
    - -

    login

    -
    login: LoginOption
    - -
    -
    -

    Set the login mode for the connection. -

    - Either DISABLED, OPTIONAL or REQUIRED

    -
    -
    -
    param
    -

    (default is OPTIONAL)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getOwnHostname

    +
      +
    • getOwnHostname(): string
      • +
    +
      +
    • + +
      +
      +

      set the hostname to be used for HELO/EHLO and the Message-ID

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    maxPoolSize

    -
    maxPoolSize: number
    - -
    -
    -

    set the max allowed number of open connections to the mail server - if not set the default is 10

    -
    -
    -
    returns
    -

    this to be able to use the object fluently

    -
    -
    -
    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Set the password for the login.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ownHostname

    -
    ownHostname: string
    - -
    -
    -

    set the hostname to be used for HELO/EHLO and the Message-ID

    -
    -
    -
    param
    -

    my own hostname to set

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port of the smtp server.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Set the password for the login.

    -
    -
    -
    param
    -

    the password

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getStarttls

    +
      +
    • getStarttls(): StartTLSOptions
      • +
    +
      +
    • + +
      +
      +

      Set the tls security mode for the connection. +

      + Either NONE, OPTIONAL or REQUIRED

      +
      +
      +

      Returns StartTLSOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port of the smtp server.

    -
    -
    -
    param
    -

    the port (default is 25)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getUsername

    +
      +
    • getUsername(): string
      • +
    +
      +
    • + +
      +
      +

      Set the username for the login.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Set the sslOnConnect mode for the connection.

    -
    -
    -
    param
    -

    true is ssl is used

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isAllowRcptErrors

    +
      +
    • isAllowRcptErrors(): boolean
      • +
    +
      +
    • + +
      +
      +

      set if sending allows rcpt errors +

      + if true, the mail will be sent to the recipients that the server accepted, if any +

      +
      +
      +

      Returns boolean

      +

      this to be able to use the object fluently

      +
      • +
    -
    - -

    starttls

    -
    starttls: StartTLSOptions
    - -
    -
    -

    Set the tls security mode for the connection. -

    - Either NONE, OPTIONAL or REQUIRED

    -
    -
    -
    param
    -

    (default is OPTIONAL)

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isDisableEsmtp

    +
      +
    • isDisableEsmtp(): boolean
      • +
    +
      +
    • + +
      +
      +

      set if ESMTP should be tried as first command (EHLO) +

      + rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP + is supported, if this returns an error code, HELO is tried to use old SMTP. + If there is a server that does not support EHLO and does not give an error code back, the connection + should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a + setting. The odds of this actually happening are very small since the client will not connect to arbitrary + smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO + in that way, the property has to be set to false. +

      +
      +
      +

      Returns boolean

      +

      this to be able to use the object fluently

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - -
    -
    -

    set whether to trust all certificates on ssl connect the option is also - applied to STARTTLS operation

    -
    -
    -
    param
    -

    trust all certificates

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isKeepAlive

    +
      +
    • isKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      set if connection pool is enabled + default is true +

      + if the connection pooling is disabled, the max number of sockets is enforced nevertheless +

      +
      +
      +

      Returns boolean

      +

      this to be able to use the object fluently

      +
      • +
    -
    - -

    username

    -
    username: string
    - -
    -
    -

    Set the username for the login.

    -
    -
    -
    param
    -

    the username

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the sslOnConnect mode for the connection.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +
      +
      +

      set whether to trust all certificates on ssl connect the option is also + applied to STARTTLS operation

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAllowRcptErrors

    +
      +
    • setAllowRcptErrors(allowRcptErrors: boolean): MailConfig
      • +
    +
      +
    • + +
      +
      +

      set if sending allows rcpt errors +

      + if true, the mail will be sent to the recipients that the server accepted, if any +

      +
      +
      +

      Parameters

      +
        +
      • +
        allowRcptErrors: boolean
        +
        +

        the allowRcptErrors to set (default is false)

        +
        +
        • +
      +

      Returns MailConfig

      +

      this to be able to use the object fluently

      +
      • +
    +
    +
    + +

    setAuthMethods

    +
      +
    • setAuthMethods(authMethods: string): MailConfig
      • +
    +
      +
    • + +
      +
      +

      set string of allowed auth methods. + if set only these methods will be used + if the server supports them. If null or empty all supported methods may be + used

      +
      +
      +

      Parameters

      +
        +
      • +
        authMethods: string
        +
        +

        the authMethods to set

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDisableEsmtp

    +
      +
    • setDisableEsmtp(disableEsmtp: boolean): MailConfig
      • +
    +
      +
    • + +
      +
      +

      set if ESMTP should be tried as first command (EHLO) +

      + rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP + is supported, if this returns an error code, HELO is tried to use old SMTP. + If there is a server that does not support EHLO and does not give an error code back, the connection + should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a + setting. The odds of this actually happening are very small since the client will not connect to arbitrary + smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO + in that way, the property has to be set to false. +

      +
      +
      +

      Parameters

      +
        +
      • +
        disableEsmtp: boolean
        +
        +

        the disableEsmtp to set (default is true)

        +
        +
        • +
      +

      Returns MailConfig

      +

      this to be able to use the object fluently

      +
      • +
    +
    +
    + +

    setHostname

    + +
      +
    • + +
      +
      +

      Set the hostname of the smtp server.

      +
      +
      +

      Parameters

      +
        +
      • +
        hostname: string
        +
        +

        the hostname (default is localhost)

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeepAlive

    +
      +
    • setKeepAlive(keepAlive: boolean): MailConfig
      • +
    +
      +
    • + +
      +
      +

      set if connection pool is enabled + default is true +

      + if the connection pooling is disabled, the max number of sockets is enforced nevertheless +

      +
      +
      +

      Parameters

      +
        +
      • +
        keepAlive: boolean
        +
        • +
      +

      Returns MailConfig

      +

      this to be able to use the object fluently

      +
      • +
    +
    +
    + +

    setKeyStore

    + +
      +
    • + +
      +
      +

      get the key store filename to be used when opening SMTP connections +

      + if not set, an options object will be created based on other settings (ssl + and trustAll)

      +
      +
      +

      Parameters

      +
        +
      • +
        keyStore: string
        +
        +

        the key store filename to be set

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeyStorePassword

    +
      +
    • setKeyStorePassword(keyStorePassword: string): MailConfig
      • +
    +
      +
    • + +
      +
      +

      get the key store password to be used when opening SMTP connections

      +
      +
      +

      Parameters

      +
        +
      • +
        keyStorePassword: string
        +
        +

        the key store passwords to be set

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLogin

    + +
      +
    • + +
      +
      +

      Set the login mode for the connection. +

      + Either DISABLED, OPTIONAL or REQUIRED

      +
      +
      +

      Parameters

      +
        +
      • +
        login: LoginOption
        +
        +

        (default is OPTIONAL)

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setMaxPoolSize

    +
      +
    • setMaxPoolSize(maxPoolSize: number): MailConfig
      • +
    +
      +
    • + +
      +
      +

      set the max allowed number of open connections to the mail server + if not set the default is 10

      +
      +
      +

      Parameters

      +
        +
      • +
        maxPoolSize: number
        +
        • +
      +

      Returns MailConfig

      +

      this to be able to use the object fluently

      +
      • +
    +
    +
    + +

    setOwnHostname

    +
      +
    • setOwnHostname(ownHostname: string): MailConfig
      • +
    +
      +
    • + +
      +
      +

      set the hostname to be used for HELO/EHLO and the Message-ID

      +
      +
      +

      Parameters

      +
        +
      • +
        ownHostname: string
        +
        +

        my own hostname to set

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Set the password for the login.

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        +

        the password

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the port of the smtp server.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port (default is 25)

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Set the sslOnConnect mode for the connection.

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        true is ssl is used

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setStarttls

    +
      +
    • setStarttls(starttls: StartTLSOptions): MailConfig
      • +
    +
      +
    • + +
      +
      +

      Set the tls security mode for the connection. +

      + Either NONE, OPTIONAL or REQUIRED

      +
      +
      +

      Parameters

      +
        +
      • +
        starttls: StartTLSOptions
        +
        +

        (default is OPTIONAL)

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setTrustAll

    + +
      +
    • + +
      +
      +

      set whether to trust all certificates on ssl connect the option is also + applied to STARTTLS operation

      +
      +
      +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        +

        trust all certificates

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setUsername

    + +
      +
    • + +
      +
      +

      Set the username for the login.

      +
      +
      +

      Parameters

      +
        +
      • +
        username: string
        +
        +

        the username

        +
        +
        • +
      +

      Returns MailConfig

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -515,53 +1112,104 @@

    username

  • MailConfig
    • diff --git a/docs/@vertx/mail-client/classes/mailmessage.html b/docs/@vertx/mail-client/classes/mailmessage.html index 30909b242..4c98521b5 100644 --- a/docs/@vertx/mail-client/classes/mailmessage.html +++ b/docs/@vertx/mail-client/classes/mailmessage.html @@ -77,305 +77,736 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    attachment

    -
    attachment: MailAttachment
    - -
    -
    -

    set the list of attachments of this mail

    -
    -
    -
    param
    -

    List of attachment

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns MailMessage

      +
      • +
    • + +

      Parameters

      + +

      Returns MailMessage

      +
      • +
    -
    - -

    bcc

    -
    bcc: string
    - -
    -
    -

    set list of bcc addresses

    -
    -
    -
    param
    -

    List of bcc addresses

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addHeader

    + +
      +
    • + +
      +
      +

      Add a message header.

      +
      +
      +

      Parameters

      +
        +
      • +
        headers: string
        +
        • +
      +

      Returns MailMessage

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    bounceAddress

    -
    bounceAddress: string
    - -
    -
    -

    set bounce address of this mail

    -
    -
    -
    param
    -

    bounce address

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getAttachment

    + +
      +
    • + +
      +
      +

      set the list of attachments of this mail

      +
      +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    cc

    -
    cc: string
    - -
    -
    -

    set list of cc addresses

    -
    -
    -
    param
    -

    List of cc addresses

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getBcc

    +
      +
    • getBcc(): string
      • +
    +
      +
    • + +
      +
      +

      set list of bcc addresses

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    fixedHeaders

    -
    fixedHeaders: boolean
    - -
    -
    -

    set whether our own headers should be the only headers added to the message

    -
    -
    -
    param
    -

    the fixedHeaders to set

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getBounceAddress

    +
      +
    • getBounceAddress(): string
      • +
    +
      +
    • + +
      +
      +

      set bounce address of this mail

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    from

    -
    from: string
    - -
    -
    -

    set from address of this mail

    -
    -
    -
    param
    -

    from addrss

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    getCc

    +
      +
    • getCc(): string
      • +
    +
      +
    • + +
      +
      +

      set list of cc addresses

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getFrom

    +
      +
    • getFrom(): string
      • +
    +
      +
    • + +
      +
      +

      set from address of this mail

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getHtml

    +
      +
    • getHtml(): string
      • +
    +
      +
    • + +
      +
      +

      set the html text of this mail

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getInlineAttachment

    + +
      +
    • + +
      +
      +

      set the list of inline attachments of this mail

      +
      +
      +

      Returns MailAttachment

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getSubject

    +
      +
    • getSubject(): string
      • +
    +
      +
    • + +
      +
      +

      set the subject of this mail

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getText

    +
      +
    • getText(): string
      • +
    +
      +
    • + +
      +
      +

      set the plain text of this mail

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    getTo

    +
      +
    • getTo(): string
      • +
    +
      +
    • + +
      +
      +

      set list of to addresses

      +
      +
      +

      Returns string

      +

      this to be able to use it fluently

      +
      • +
    -
    +

    headers

    -
    headers: string
    - -
    -
    -

    Add a message header.

    -
    -
    -
    param
    -

    the header key

    -
    -
    param
    -

    the header value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • headers(): string
      • +
    +
      +
    • + +
      +
      +

      Add a message header.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    html

    -
    html: string
    - -
    -
    -

    set the html text of this mail

    -
    -
    -
    param
    -

    the text

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    isFixedHeaders

    +
      +
    • isFixedHeaders(): boolean
      • +
    +
      +
    • + +
      +
      +

      set whether our own headers should be the only headers added to the message

      +
      +
      +

      Returns boolean

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    inlineAttachment

    -
    inlineAttachment: MailAttachment
    - -
    -
    -

    set the list of inline attachments of this mail

    -
    -
    -
    param
    -

    List of attachment

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    setAttachment

    + +
      +
    • + +
      +
      +

      set the list of attachments of this mail

      +
      +
      +

      Parameters

      + +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    subject

    -
    subject: string
    - -
    -
    -

    set the subject of this mail

    -
    -
    -
    param
    -

    the subject

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    setBcc

    + +
      +
    • + +
      +
      +

      set list of bcc addresses

      +
      +
      +

      Parameters

      +
        +
      • +
        bcc: string
        +
        +

        List of bcc addresses

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    text

    -
    text: string
    - -
    -
    -

    set the plain text of this mail

    -
    -
    -
    param
    -

    the text

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    setBounceAddress

    +
      +
    • setBounceAddress(bounceAddress: string): MailMessage
      • +
    +
      +
    • + +
      +
      +

      set bounce address of this mail

      +
      +
      +

      Parameters

      +
        +
      • +
        bounceAddress: string
        +
        +

        bounce address

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    -
    - -

    to

    -
    to: string
    - -
    -
    -

    set list of to addresses

    -
    -
    -
    param
    -

    List of to addresses

    -
    -
    returns
    -

    this to be able to use it fluently

    -
    -
    -
    +
    + +

    setCc

    + +
      +
    • + +
      +
      +

      set list of cc addresses

      +
      +
      +

      Parameters

      +
        +
      • +
        cc: string
        +
        +

        List of cc addresses

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setFixedHeaders

    +
      +
    • setFixedHeaders(fixedHeaders: boolean): MailMessage
      • +
    +
      +
    • + +
      +
      +

      set whether our own headers should be the only headers added to the message

      +
      +
      +

      Parameters

      +
        +
      • +
        fixedHeaders: boolean
        +
        +

        the fixedHeaders to set

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setFrom

    + +
      +
    • + +
      +
      +

      set from address of this mail

      +
      +
      +

      Parameters

      +
        +
      • +
        from: string
        +
        +

        from addrss

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setHtml

    + +
      +
    • + +
      +
      +

      set the html text of this mail

      +
      +
      +

      Parameters

      +
        +
      • +
        html: string
        +
        +

        the text

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setInlineAttachment

    + +
      +
    • + +
      +
      +

      set the list of inline attachments of this mail

      +
      +
      +

      Parameters

      + +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setSubject

    + +
      +
    • + +
      +
      +

      set the subject of this mail

      +
      +
      +

      Parameters

      +
        +
      • +
        subject: string
        +
        +

        the subject

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setText

    + +
      +
    • + +
      +
      +

      set the plain text of this mail

      +
      +
      +

      Parameters

      +
        +
      • +
        text: string
        +
        +

        the text

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    +
    +
    + +

    setTo

    + +
      +
    • + +
      +
      +

      set list of to addresses

      +
      +
      +

      Parameters

      +
        +
      • +
        to: string
        +
        +

        List of to addresses

        +
        +
        • +
      +

      Returns MailMessage

      +

      this to be able to use it fluently

      +
      • +
    @@ -403,41 +834,80 @@

    to

  • MailMessage
    • diff --git a/docs/@vertx/mail-client/classes/mailresult.html b/docs/@vertx/mail-client/classes/mailresult.html index 909290579..6c932af5a 100644 --- a/docs/@vertx/mail-client/classes/mailresult.html +++ b/docs/@vertx/mail-client/classes/mailresult.html @@ -77,50 +77,153 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    messageID

    -
    messageID: string
    - -
    -
    -
    param
    -

    the messageID to set

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns MailResult

      +
      • +
    • + +

      Parameters

      + +

      Returns MailResult

      +
      • +
    -
    - -

    recipients

    -
    recipients: string
    - -
    -
    -
    param
    -

    the recipients to set

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getMessageID

    +
      +
    • getMessageID(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +
      • +
    +
    +
    + +

    getRecipients

    +
      +
    • getRecipients(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +
      • +
    +
    +
    + +

    setMessageID

    + +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • +
        messageID: string
        +
        +

        the messageID to set

        +
        +
        • +
      +

      Returns MailResult

      +
      • +
    +
    +
    + +

    setRecipients

    +
      +
    • setRecipients(recipients: string): MailResult
      • +
    +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • +
        recipients: string
        +
        +

        the recipients to set

        +
        +
        • +
      +

      Returns MailResult

      +
      • +
    @@ -151,11 +254,20 @@

    recipients

  • MailResult
    • diff --git a/docs/@vertx/micrometer-metrics/assets/js/search.js b/docs/@vertx/micrometer-metrics/assets/js/search.js index c2b9bc29c..532e75a71 100644 --- a/docs/@vertx/micrometer-metrics/assets/js/search.js +++ b/docs/@vertx/micrometer-metrics/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"MetricsDomain","url":"enums/metricsdomain.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"NET_SERVER","url":"enums/metricsdomain.html#net_server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":2,"kind":16,"name":"NET_CLIENT","url":"enums/metricsdomain.html#net_client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":3,"kind":16,"name":"HTTP_SERVER","url":"enums/metricsdomain.html#http_server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":4,"kind":16,"name":"HTTP_CLIENT","url":"enums/metricsdomain.html#http_client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":5,"kind":16,"name":"DATAGRAM_SOCKET","url":"enums/metricsdomain.html#datagram_socket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":6,"kind":16,"name":"EVENT_BUS","url":"enums/metricsdomain.html#event_bus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":7,"kind":16,"name":"NAMED_POOLS","url":"enums/metricsdomain.html#named_pools","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":8,"kind":16,"name":"VERTICLES","url":"enums/metricsdomain.html#verticles","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":9,"kind":128,"name":"MetricsService","url":"classes/metricsservice.html","classes":"tsd-kind-class"},{"id":10,"kind":2048,"name":"create","url":"classes/metricsservice.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MetricsService"},{"id":11,"kind":2048,"name":"getBaseName","url":"classes/metricsservice.html#getbasename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":12,"kind":2048,"name":"metricsNames","url":"classes/metricsservice.html#metricsnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":13,"kind":2048,"name":"getMetricsSnapshot","url":"classes/metricsservice.html#getmetricssnapshot","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":14,"kind":128,"name":"Match","url":"classes/match.html","classes":"tsd-kind-class"},{"id":15,"kind":1024,"name":"alias","url":"classes/match.html#alias","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":16,"kind":1024,"name":"domain","url":"classes/match.html#domain","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":17,"kind":1024,"name":"label","url":"classes/match.html#label","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":18,"kind":1024,"name":"type","url":"classes/match.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":19,"kind":1024,"name":"value","url":"classes/match.html#value","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Match"},{"id":20,"kind":128,"name":"MicrometerMetricsOptions","url":"classes/micrometermetricsoptions.html","classes":"tsd-kind-class"},{"id":21,"kind":1024,"name":"disabledMetricsCategories","url":"classes/micrometermetricsoptions.html#disabledmetricscategories","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":22,"kind":1024,"name":"enabled","url":"classes/micrometermetricsoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":23,"kind":1024,"name":"influxDbOptions","url":"classes/micrometermetricsoptions.html#influxdboptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":24,"kind":1024,"name":"jmxMetricsOptions","url":"classes/micrometermetricsoptions.html#jmxmetricsoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":25,"kind":1024,"name":"labelMatchs","url":"classes/micrometermetricsoptions.html#labelmatchs","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":26,"kind":1024,"name":"prometheusOptions","url":"classes/micrometermetricsoptions.html#prometheusoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":27,"kind":1024,"name":"registryName","url":"classes/micrometermetricsoptions.html#registryname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":28,"kind":128,"name":"VertxInfluxDbOptions","url":"classes/vertxinfluxdboptions.html","classes":"tsd-kind-class"},{"id":29,"kind":1024,"name":"batchSize","url":"classes/vertxinfluxdboptions.html#batchsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":30,"kind":1024,"name":"compressed","url":"classes/vertxinfluxdboptions.html#compressed","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":31,"kind":1024,"name":"connectTimeout","url":"classes/vertxinfluxdboptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":32,"kind":1024,"name":"db","url":"classes/vertxinfluxdboptions.html#db","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":33,"kind":1024,"name":"enabled","url":"classes/vertxinfluxdboptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":34,"kind":1024,"name":"numThreads","url":"classes/vertxinfluxdboptions.html#numthreads","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":35,"kind":1024,"name":"password","url":"classes/vertxinfluxdboptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":36,"kind":1024,"name":"readTimeout","url":"classes/vertxinfluxdboptions.html#readtimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":37,"kind":1024,"name":"retentionPolicy","url":"classes/vertxinfluxdboptions.html#retentionpolicy","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":38,"kind":1024,"name":"step","url":"classes/vertxinfluxdboptions.html#step","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":39,"kind":1024,"name":"uri","url":"classes/vertxinfluxdboptions.html#uri","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":40,"kind":1024,"name":"userName","url":"classes/vertxinfluxdboptions.html#username","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":41,"kind":128,"name":"VertxJmxMetricsOptions","url":"classes/vertxjmxmetricsoptions.html","classes":"tsd-kind-class"},{"id":42,"kind":1024,"name":"domain","url":"classes/vertxjmxmetricsoptions.html#domain","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":43,"kind":1024,"name":"enabled","url":"classes/vertxjmxmetricsoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":44,"kind":1024,"name":"step","url":"classes/vertxjmxmetricsoptions.html#step","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":45,"kind":128,"name":"VertxPrometheusOptions","url":"classes/vertxprometheusoptions.html","classes":"tsd-kind-class"},{"id":46,"kind":1024,"name":"embeddedServerEndpoint","url":"classes/vertxprometheusoptions.html#embeddedserverendpoint","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":47,"kind":1024,"name":"embeddedServerOptions","url":"classes/vertxprometheusoptions.html#embeddedserveroptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":48,"kind":1024,"name":"enabled","url":"classes/vertxprometheusoptions.html#enabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":49,"kind":1024,"name":"startEmbeddedServer","url":"classes/vertxprometheusoptions.html#startembeddedserver","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VertxPrometheusOptions"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"Label","url":"enums/label.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"LOCAL","url":"enums/label.html#local","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":2,"kind":16,"name":"REMOTE","url":"enums/label.html#remote","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":3,"kind":16,"name":"HTTP_PATH","url":"enums/label.html#http_path","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":4,"kind":16,"name":"HTTP_METHOD","url":"enums/label.html#http_method","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":5,"kind":16,"name":"HTTP_CODE","url":"enums/label.html#http_code","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":6,"kind":16,"name":"CLASS_NAME","url":"enums/label.html#class_name","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":7,"kind":16,"name":"EB_ADDRESS","url":"enums/label.html#eb_address","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":8,"kind":16,"name":"EB_SIDE","url":"enums/label.html#eb_side","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":9,"kind":16,"name":"EB_FAILURE","url":"enums/label.html#eb_failure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":10,"kind":16,"name":"POOL_TYPE","url":"enums/label.html#pool_type","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":11,"kind":16,"name":"POOL_NAME","url":"enums/label.html#pool_name","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Label"},{"id":12,"kind":4,"name":"MatchType","url":"enums/matchtype.html","classes":"tsd-kind-enum"},{"id":13,"kind":16,"name":"EQUALS","url":"enums/matchtype.html#equals","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MatchType"},{"id":14,"kind":16,"name":"REGEX","url":"enums/matchtype.html#regex","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MatchType"},{"id":15,"kind":4,"name":"MetricsDomain","url":"enums/metricsdomain.html","classes":"tsd-kind-enum"},{"id":16,"kind":16,"name":"NET_SERVER","url":"enums/metricsdomain.html#net_server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":17,"kind":16,"name":"NET_CLIENT","url":"enums/metricsdomain.html#net_client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":18,"kind":16,"name":"HTTP_SERVER","url":"enums/metricsdomain.html#http_server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":19,"kind":16,"name":"HTTP_CLIENT","url":"enums/metricsdomain.html#http_client","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":20,"kind":16,"name":"DATAGRAM_SOCKET","url":"enums/metricsdomain.html#datagram_socket","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":21,"kind":16,"name":"EVENT_BUS","url":"enums/metricsdomain.html#event_bus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":22,"kind":16,"name":"NAMED_POOLS","url":"enums/metricsdomain.html#named_pools","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":23,"kind":16,"name":"VERTICLES","url":"enums/metricsdomain.html#verticles","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MetricsDomain"},{"id":24,"kind":128,"name":"MetricsService","url":"classes/metricsservice.html","classes":"tsd-kind-class"},{"id":25,"kind":2048,"name":"create","url":"classes/metricsservice.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MetricsService"},{"id":26,"kind":2048,"name":"getBaseName","url":"classes/metricsservice.html#getbasename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":27,"kind":2048,"name":"metricsNames","url":"classes/metricsservice.html#metricsnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":28,"kind":2048,"name":"getMetricsSnapshot","url":"classes/metricsservice.html#getmetricssnapshot","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MetricsService"},{"id":29,"kind":128,"name":"PrometheusScrapingHandler","url":"classes/prometheusscrapinghandler.html","classes":"tsd-kind-class"},{"id":30,"kind":2048,"name":"create","url":"classes/prometheusscrapinghandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PrometheusScrapingHandler"},{"id":31,"kind":128,"name":"Match","url":"classes/match.html","classes":"tsd-kind-class"},{"id":32,"kind":512,"name":"constructor","url":"classes/match.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Match"},{"id":33,"kind":2048,"name":"getAlias","url":"classes/match.html#getalias","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":34,"kind":2048,"name":"setAlias","url":"classes/match.html#setalias","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":35,"kind":2048,"name":"getDomain","url":"classes/match.html#getdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":36,"kind":2048,"name":"setDomain","url":"classes/match.html#setdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":37,"kind":2048,"name":"getLabel","url":"classes/match.html#getlabel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":38,"kind":2048,"name":"setLabel","url":"classes/match.html#setlabel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":39,"kind":2048,"name":"getType","url":"classes/match.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":40,"kind":2048,"name":"setType","url":"classes/match.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":41,"kind":2048,"name":"getValue","url":"classes/match.html#getvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":42,"kind":2048,"name":"setValue","url":"classes/match.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Match"},{"id":43,"kind":128,"name":"MicrometerMetricsOptions","url":"classes/micrometermetricsoptions.html","classes":"tsd-kind-class"},{"id":44,"kind":512,"name":"constructor","url":"classes/micrometermetricsoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":45,"kind":2048,"name":"getDisabledMetricsCategories","url":"classes/micrometermetricsoptions.html#getdisabledmetricscategories","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":46,"kind":2048,"name":"setDisabledMetricsCategories","url":"classes/micrometermetricsoptions.html#setdisabledmetricscategories","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":47,"kind":2048,"name":"isEnabled","url":"classes/micrometermetricsoptions.html#isenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":48,"kind":2048,"name":"setEnabled","url":"classes/micrometermetricsoptions.html#setenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":49,"kind":2048,"name":"getInfluxDbOptions","url":"classes/micrometermetricsoptions.html#getinfluxdboptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":50,"kind":2048,"name":"setInfluxDbOptions","url":"classes/micrometermetricsoptions.html#setinfluxdboptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":51,"kind":2048,"name":"getJmxMetricsOptions","url":"classes/micrometermetricsoptions.html#getjmxmetricsoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":52,"kind":2048,"name":"setJmxMetricsOptions","url":"classes/micrometermetricsoptions.html#setjmxmetricsoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":53,"kind":2048,"name":"isJvmMetricsEnabled","url":"classes/micrometermetricsoptions.html#isjvmmetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":54,"kind":2048,"name":"setJvmMetricsEnabled","url":"classes/micrometermetricsoptions.html#setjvmmetricsenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":55,"kind":2048,"name":"getLabelMatches","url":"classes/micrometermetricsoptions.html#getlabelmatches","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":56,"kind":2048,"name":"setLabelMatches","url":"classes/micrometermetricsoptions.html#setlabelmatches","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":57,"kind":2048,"name":"labelMatchs","url":"classes/micrometermetricsoptions.html#labelmatchs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":58,"kind":2048,"name":"addLabelMatch","url":"classes/micrometermetricsoptions.html#addlabelmatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":59,"kind":2048,"name":"getLabels","url":"classes/micrometermetricsoptions.html#getlabels","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":60,"kind":2048,"name":"setLabels","url":"classes/micrometermetricsoptions.html#setlabels","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":61,"kind":2048,"name":"getPrometheusOptions","url":"classes/micrometermetricsoptions.html#getprometheusoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":62,"kind":2048,"name":"setPrometheusOptions","url":"classes/micrometermetricsoptions.html#setprometheusoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":63,"kind":2048,"name":"getRegistryName","url":"classes/micrometermetricsoptions.html#getregistryname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":64,"kind":2048,"name":"setRegistryName","url":"classes/micrometermetricsoptions.html#setregistryname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MicrometerMetricsOptions"},{"id":65,"kind":128,"name":"VertxInfluxDbOptions","url":"classes/vertxinfluxdboptions.html","classes":"tsd-kind-class"},{"id":66,"kind":512,"name":"constructor","url":"classes/vertxinfluxdboptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":67,"kind":2048,"name":"getBatchSize","url":"classes/vertxinfluxdboptions.html#getbatchsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":68,"kind":2048,"name":"setBatchSize","url":"classes/vertxinfluxdboptions.html#setbatchsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":69,"kind":2048,"name":"isCompressed","url":"classes/vertxinfluxdboptions.html#iscompressed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":70,"kind":2048,"name":"setCompressed","url":"classes/vertxinfluxdboptions.html#setcompressed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":71,"kind":2048,"name":"getConnectTimeout","url":"classes/vertxinfluxdboptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":72,"kind":2048,"name":"setConnectTimeout","url":"classes/vertxinfluxdboptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":73,"kind":2048,"name":"getDb","url":"classes/vertxinfluxdboptions.html#getdb","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":74,"kind":2048,"name":"setDb","url":"classes/vertxinfluxdboptions.html#setdb","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":75,"kind":2048,"name":"isEnabled","url":"classes/vertxinfluxdboptions.html#isenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":76,"kind":2048,"name":"setEnabled","url":"classes/vertxinfluxdboptions.html#setenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":77,"kind":2048,"name":"getNumThreads","url":"classes/vertxinfluxdboptions.html#getnumthreads","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":78,"kind":2048,"name":"setNumThreads","url":"classes/vertxinfluxdboptions.html#setnumthreads","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":79,"kind":2048,"name":"getPassword","url":"classes/vertxinfluxdboptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":80,"kind":2048,"name":"setPassword","url":"classes/vertxinfluxdboptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":81,"kind":2048,"name":"getReadTimeout","url":"classes/vertxinfluxdboptions.html#getreadtimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":82,"kind":2048,"name":"setReadTimeout","url":"classes/vertxinfluxdboptions.html#setreadtimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":83,"kind":2048,"name":"getRetentionPolicy","url":"classes/vertxinfluxdboptions.html#getretentionpolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":84,"kind":2048,"name":"setRetentionPolicy","url":"classes/vertxinfluxdboptions.html#setretentionpolicy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":85,"kind":2048,"name":"getStep","url":"classes/vertxinfluxdboptions.html#getstep","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":86,"kind":2048,"name":"setStep","url":"classes/vertxinfluxdboptions.html#setstep","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":87,"kind":2048,"name":"getUri","url":"classes/vertxinfluxdboptions.html#geturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":88,"kind":2048,"name":"setUri","url":"classes/vertxinfluxdboptions.html#seturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":89,"kind":2048,"name":"getUserName","url":"classes/vertxinfluxdboptions.html#getusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":90,"kind":2048,"name":"setUserName","url":"classes/vertxinfluxdboptions.html#setusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxInfluxDbOptions"},{"id":91,"kind":128,"name":"VertxJmxMetricsOptions","url":"classes/vertxjmxmetricsoptions.html","classes":"tsd-kind-class"},{"id":92,"kind":512,"name":"constructor","url":"classes/vertxjmxmetricsoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":93,"kind":2048,"name":"getDomain","url":"classes/vertxjmxmetricsoptions.html#getdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":94,"kind":2048,"name":"setDomain","url":"classes/vertxjmxmetricsoptions.html#setdomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":95,"kind":2048,"name":"isEnabled","url":"classes/vertxjmxmetricsoptions.html#isenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":96,"kind":2048,"name":"setEnabled","url":"classes/vertxjmxmetricsoptions.html#setenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":97,"kind":2048,"name":"getStep","url":"classes/vertxjmxmetricsoptions.html#getstep","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":98,"kind":2048,"name":"setStep","url":"classes/vertxjmxmetricsoptions.html#setstep","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxJmxMetricsOptions"},{"id":99,"kind":128,"name":"VertxPrometheusOptions","url":"classes/vertxprometheusoptions.html","classes":"tsd-kind-class"},{"id":100,"kind":512,"name":"constructor","url":"classes/vertxprometheusoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":101,"kind":2048,"name":"getEmbeddedServerEndpoint","url":"classes/vertxprometheusoptions.html#getembeddedserverendpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":102,"kind":2048,"name":"setEmbeddedServerEndpoint","url":"classes/vertxprometheusoptions.html#setembeddedserverendpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":103,"kind":2048,"name":"getEmbeddedServerOptions","url":"classes/vertxprometheusoptions.html#getembeddedserveroptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":104,"kind":2048,"name":"setEmbeddedServerOptions","url":"classes/vertxprometheusoptions.html#setembeddedserveroptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":105,"kind":2048,"name":"isEnabled","url":"classes/vertxprometheusoptions.html#isenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":106,"kind":2048,"name":"setEnabled","url":"classes/vertxprometheusoptions.html#setenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":107,"kind":2048,"name":"isPublishQuantiles","url":"classes/vertxprometheusoptions.html#ispublishquantiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":108,"kind":2048,"name":"setPublishQuantiles","url":"classes/vertxprometheusoptions.html#setpublishquantiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":109,"kind":2048,"name":"isStartEmbeddedServer","url":"classes/vertxprometheusoptions.html#isstartembeddedserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"},{"id":110,"kind":2048,"name":"setStartEmbeddedServer","url":"classes/vertxprometheusoptions.html#setstartembeddedserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VertxPrometheusOptions"}]}; \ No newline at end of file diff --git a/docs/@vertx/micrometer-metrics/classes/match.html b/docs/@vertx/micrometer-metrics/classes/match.html index c4d6f89ee..bf1e923e6 100644 --- a/docs/@vertx/micrometer-metrics/classes/match.html +++ b/docs/@vertx/micrometer-metrics/classes/match.html @@ -77,134 +77,340 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    alias

    -
    alias: string
    - -
    -
    -

    Set an alias that would replace the label value when it matches.

    -
    -
    -
    param
    -

    the matcher alias

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Match

      +
      • +
    • + +

      Parameters

      + +

      Returns Match

      +
      • +
    -
    - -

    domain

    -
    domain: MetricsDomain
    - -
    -
    -

    Set the label domain, restricting this rule to a single domain.

    -
    -
    -
    param
    -

    the label domain

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAlias

    +
      +
    • getAlias(): string
      • +
    +
      +
    • + +
      +
      +

      Set an alias that would replace the label value when it matches.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    label

    -
    label: string
    - -
    -
    -

    Set the label name. The match will apply to the values related to this key.

    -
    -
    -
    param
    -

    the label name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDomain

    + +
      +
    • + +
      +
      +

      Set the label domain, restricting this rule to a single domain.

      +
      +
      +

      Returns MetricsDomain

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    type

    -
    type: MatchType
    - -
    -
    -

    Set the type of matching to apply.

    -
    -
    -
    param
    -

    the matcher type

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getLabel

    +
      +
    • getLabel(): string
      • +
    +
      +
    • + +
      +
      +

      Set the label name. The match will apply to the values related to this key.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    value

    -
    value: string
    - -
    -
    -

    Set the matched value.

    -
    -
    -
    param
    -

    the value to match

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getType

    + +
      +
    • + +
      +
      +

      Set the type of matching to apply.

      +
      +
      +

      Returns MatchType

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getValue

    +
      +
    • getValue(): string
      • +
    +
      +
    • + +
      +
      +

      Set the matched value.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAlias

    +
      +
    • setAlias(alias: string): Match
      • +
    +
      +
    • + +
      +
      +

      Set an alias that would replace the label value when it matches.

      +
      +
      +

      Parameters

      +
        +
      • +
        alias: string
        +
        +

        the matcher alias

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setDomain

    + +
      +
    • + +
      +
      +

      Set the label domain, restricting this rule to a single domain.

      +
      +
      +

      Parameters

      + +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLabel

    +
      +
    • setLabel(label: string): Match
      • +
    +
      +
    • + +
      +
      +

      Set the label name. The match will apply to the values related to this key.

      +
      +
      +

      Parameters

      +
        +
      • +
        label: string
        +
        +

        the label name

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +
      +
      +

      Set the type of matching to apply.

      +
      +
      +

      Parameters

      +
        +
      • +
        type: MatchType
        +
        +

        the matcher type

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setValue

    +
      +
    • setValue(value: string): Match
      • +
    +
      +
    • + +
      +
      +

      Set the matched value.

      +
      +
      +

      Parameters

      +
        +
      • +
        value: string
        +
        +

        the value to match

        +
        +
        • +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -218,6 +424,12 @@

    value

    @@ -166,7 +176,7 @@

    metricsNames

  • @@ -186,12 +196,12 @@

    Static create

  • -

    Creates a metric service for a given {@link Measured} object.

    +

    Creates a metric service for a given {@link Measured} object.

    Parameters

    @@ -220,6 +230,12 @@

    Returns

    • -

    Properties

    -
    - -

    disabledMetricsCategories

    -
    disabledMetricsCategories: MetricsDomain
    - -
    -
    -

    Sets metrics types that are disabled.

    -
    -
    -
    param
    -

    to specify the set of metrics types to be disabled.

    -
    -
    returns
    -

    a reference to this, so that the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    enabled

    -
    enabled: boolean
    - -
    -
    -

    Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

    -
    -
    +
    +
    +

    Methods

    +
    + +

    addLabelMatch

    + +
      +
    • + +
      +
      +

      Add a rule for label matching.

      +
      +
      +

      Parameters

      +
        +
      • +
        labelMatchs: Match
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    influxDbOptions

    -
    influxDbOptions: VertxInfluxDbOptions
    - -
    -
    -

    Set InfluxDB options. - Setting a registry backend option is mandatory in order to effectively report metrics.

    -
    -
    -
    param
    -

    backend options for InfluxDB

    -
    -
    -
    +
    + +

    getDisabledMetricsCategories

    + +
      +
    • + +
      +
      +

      Sets metrics types that are disabled.

      +
      +
      +

      Returns MetricsDomain

      +

      a reference to this, so that the API can be used fluently

      +
      • +
    -
    - -

    jmxMetricsOptions

    -
    jmxMetricsOptions: VertxJmxMetricsOptions
    - -
    -
    -

    Set JMX metrics options. - Setting a registry backend option is mandatory in order to effectively report metrics.

    -
    -
    -
    param
    -

    backend options for JMX reporting

    -
    -
    -
    +
    + +

    getInfluxDbOptions

    + +
      +
    • + +
      +
      +

      Set InfluxDB options. + Setting a registry backend option is mandatory in order to effectively report metrics.

      +
      +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    getJmxMetricsOptions

    + +
      +
    • + +
      +
      +

      Set JMX metrics options. + Setting a registry backend option is mandatory in order to effectively report metrics.

      +
      +
      +

      Returns VertxJmxMetricsOptions

      +
      • +
    -
    +
    + +

    getLabelMatches

    +
      +
    • getLabelMatches(): Match
      • +
    +
      +
    • + +
      +
      +

      Set a list of rules for label matching.

      +
      +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getLabels

    + +
      +
    • + +
      +
      +

      Sets enabled labels. These labels can be fine-tuned later on using Micrometer's Meter filters (see http://micrometer.io/docs/concepts#_meter_filters)

      +
      +
      +

      Returns Label

      +

      a reference to this, so that the API can be used fluently

      +
      • +
    +
    +
    + +

    getPrometheusOptions

    + +
      +
    • + +
      +
      +

      Set Prometheus options. + Setting a registry backend option is mandatory in order to effectively report metrics.

      +
      +
      +

      Returns VertxPrometheusOptions

      +
      • +
    +
    +
    + +

    getRegistryName

    +
      +
    • getRegistryName(): string
      • +
    +
      +
    • + +
      +
      +

      Set a name for the metrics registry, so that a new registry will be created and associated with this name. + If {@code registryName} is not provided (or null), a default registry will be used. + If the same name is given to several Vert.x instances (within the same JVM), they will share the same registry.

      +
      +
      +

      Returns string

      +
      • +
    +
    +
    + +

    isEnabled

    +
      +
    • isEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isJvmMetricsEnabled

    +
      +
    • isJvmMetricsEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Whether JVM metrics should be collected. Defaults to {@code false}.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +

    labelMatchs

    -
    labelMatchs: Match
    - -
    -
    -

    Set a list of rules for label matching.

    -
    -
    -
    param
    -

    the new list of rules

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • labelMatchs(): Match
      • +
    +
      +
    • + +
      +
      +

      Add a rule for label matching.

      +
      +
      +

      Returns Match

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    prometheusOptions

    -
    prometheusOptions: VertxPrometheusOptions
    - -
    -
    -

    Set Prometheus options. - Setting a registry backend option is mandatory in order to effectively report metrics.

    -
    -
    -
    param
    -

    backend options for Prometheus

    -
    -
    -
    +
    + +

    setDisabledMetricsCategories

    + +
      +
    • + +
      +
      +

      Sets metrics types that are disabled.

      +
      +
      +

      Parameters

      +
        +
      • +
        disabledMetricsCategories: MetricsDomain
        +
        +

        to specify the set of metrics types to be disabled.

        +
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +

      a reference to this, so that the API can be used fluently

      +
      • +
    -
    - -

    registryName

    -
    registryName: string
    - -
    -
    -

    Set a name for the metrics registry, so that a new registry will be created and associated with this name. - If {@code registryName} is not provided (or null), a default registry will be used. - If the same name is given to several Vert.x instances (within the same JVM), they will share the same registry.

    -
    -
    -
    param
    -

    a name to uniquely identify this registry

    -
    -
    -
    +
    + +

    setEnabled

    + +
      +
    • + +
      +
      +

      Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        enabled: boolean
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +
      • +
    +
    +
    + +

    setInfluxDbOptions

    + +
      +
    • + +
      +
      +

      Set InfluxDB options. + Setting a registry backend option is mandatory in order to effectively report metrics.

      +
      +
      +

      Parameters

      + +

      Returns MicrometerMetricsOptions

      +
      • +
    +
    +
    + +

    setJmxMetricsOptions

    + +
      +
    • + +
      +
      +

      Set JMX metrics options. + Setting a registry backend option is mandatory in order to effectively report metrics.

      +
      +
      +

      Parameters

      + +

      Returns MicrometerMetricsOptions

      +
      • +
    +
    +
    + +

    setJvmMetricsEnabled

    + +
      +
    • + +
      +
      +

      Whether JVM metrics should be collected. Defaults to {@code false}.

      +
      +
      +

      Parameters

      +
        +
      • +
        jvmMetricsEnabled: boolean
        +
        +

        true to collect JVM metrics, false otherwise. Defaults to {@code false}.

        +
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLabelMatches

    + +
      +
    • + +
      +
      +

      Set a list of rules for label matching.

      +
      +
      +

      Parameters

      +
        +
      • +
        labelMatches: Match
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setLabels

    + +
      +
    • + +
      +
      +

      Sets enabled labels. These labels can be fine-tuned later on using Micrometer's Meter filters (see http://micrometer.io/docs/concepts#_meter_filters)

      +
      +
      +

      Parameters

      +
        +
      • +
        labels: Label
        +
        +

        the set of enabled labels - this set will replace any previously enabled labels, including the default ones

        +
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +

      a reference to this, so that the API can be used fluently

      +
      • +
    +
    +
    + +

    setPrometheusOptions

    + +
      +
    • + +
      +
      +

      Set Prometheus options. + Setting a registry backend option is mandatory in order to effectively report metrics.

      +
      +
      +

      Parameters

      + +

      Returns MicrometerMetricsOptions

      +
      • +
    +
    +
    + +

    setRegistryName

    + +
      +
    • + +
      +
      +

      Set a name for the metrics registry, so that a new registry will be created and associated with this name. + If {@code registryName} is not provided (or null), a default registry will be used. + If the same name is given to several Vert.x instances (within the same JVM), they will share the same registry.

      +
      +
      +

      Parameters

      +
        +
      • +
        registryName: string
        +
        +

        a name to uniquely identify this registry

        +
        +
        • +
      +

      Returns MicrometerMetricsOptions

      +
      • +
    @@ -251,6 +700,12 @@

    registryName

    -

    Properties

    -
    - -

    batchSize

    -
    batchSize: number
    - -
    -
    -

    Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. - Default is 10000.

    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    compressed

    -
    compressed: boolean
    - -
    -
    -

    Activate or deactivate GZIP compression. It is activated by default.

    -
    -
    +
    +
    +

    Methods

    +
    + +

    getBatchSize

    +
      +
    • getBatchSize(): number
      • +
    +
      +
    • + +
      +
      +

      Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. + Default is 10000.

      +
      +
      +

      Returns number

      +
      • +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - -
    -
    -

    Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

    -
    -
    +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

      +
      +
      +

      Returns number

      +
      • +
    -
    - -

    db

    -
    db: string
    - -
    -
    -

    Database name used to store metrics. Default is "default".

    -
    -
    +
    + +

    getDb

    +
      +
    • getDb(): string
      • +
    +
      +
    • + +
      +
      +

      Database name used to store metrics. Default is "default".

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    enabled

    -
    enabled: boolean
    - -
    -
    -

    Set true to enable InfluxDB reporting

    -
    -
    +
    + +

    getNumThreads

    +
      +
    • getNumThreads(): number
      • +
    +
      +
    • + +
      +
      +

      Number of threads to use by the push scheduler. Default is 2.

      +
      +
      +

      Returns number

      +
      • +
    -
    - -

    numThreads

    -
    numThreads: number
    - -
    -
    -

    Number of threads to use by the push scheduler. Default is 2.

    -
    -
    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Password used for authenticated connections

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Password used for authenticated connections

    -
    -
    +
    + +

    getReadTimeout

    +
      +
    • getReadTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

      +
      +
      +

      Returns number

      +
      • +
    -
    - -

    readTimeout

    -
    readTimeout: number
    - -
    -
    -

    Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

    -
    -
    +
    + +

    getRetentionPolicy

    +
      +
    • getRetentionPolicy(): string
      • +
    +
      +
    • + +
      +
      +

      InfluxDB retention policy

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    retentionPolicy

    -
    retentionPolicy: string
    - -
    -
    -

    InfluxDB retention policy

    -
    -
    +
    + +

    getStep

    +
      +
    • getStep(): number
      • +
    +
      +
    • + +
      +
      +

      Push interval steps, in seconds. Default is 10 seconds.

      +
      +
      +

      Returns number

      +
      • +
    -
    - -

    step

    -
    step: number
    - -
    -
    -

    Push interval steps, in seconds. Default is 10 seconds.

    -
    -
    +
    + +

    getUri

    +
      +
    • getUri(): string
      • +
    +
      +
    • + +
      +
      +

      URI of the InfluxDB server. Example: http://influx:8086.

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    uri

    -
    uri: string
    - -
    -
    -

    URI of the InfluxDB server. Example: http://influx:8086.

    -
    -
    +
    + +

    getUserName

    +
      +
    • getUserName(): string
      • +
    +
      +
    • + +
      +
      +

      Username used for authenticated connections

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    userName

    -
    userName: string
    - -
    -
    -

    Username used for authenticated connections

    -
    -
    +
    + +

    isCompressed

    +
      +
    • isCompressed(): boolean
      • +
    +
      +
    • + +
      +
      +

      Activate or deactivate GZIP compression. It is activated by default.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isEnabled

    +
      +
    • isEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set true to enable InfluxDB reporting

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    setBatchSize

    + +
      +
    • + +
      +
      +

      Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. + Default is 10000.

      +
      +
      +

      Parameters

      +
        +
      • +
        batchSize: number
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setCompressed

    + +
      +
    • + +
      +
      +

      Activate or deactivate GZIP compression. It is activated by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        compressed: boolean
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +
      +
      +

      Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

      +
      +
      +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setDb

    + +
      +
    • + +
      +
      +

      Database name used to store metrics. Default is "default".

      +
      +
      +

      Parameters

      +
        +
      • +
        db: string
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setEnabled

    + +
      +
    • + +
      +
      +

      Set true to enable InfluxDB reporting

      +
      +
      +

      Parameters

      +
        +
      • +
        enabled: boolean
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setNumThreads

    + +
      +
    • + +
      +
      +

      Number of threads to use by the push scheduler. Default is 2.

      +
      +
      +

      Parameters

      +
        +
      • +
        numThreads: number
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Password used for authenticated connections

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setReadTimeout

    + +
      +
    • + +
      +
      +

      Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        readTimeout: number
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setRetentionPolicy

    + +
      +
    • + +
      +
      +

      InfluxDB retention policy

      +
      +
      +

      Parameters

      +
        +
      • +
        retentionPolicy: string
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setStep

    + +
      +
    • + +
      +
      +

      Push interval steps, in seconds. Default is 10 seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        step: number
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    +
    +
    + +

    setUri

    + + +
    +
    + +

    setUserName

    + +
      +
    • + +
      +
      +

      Username used for authenticated connections

      +
      +
      +

      Parameters

      +
        +
      • +
        userName: string
        +
        • +
      +

      Returns VertxInfluxDbOptions

      +
      • +
    @@ -291,6 +765,12 @@

    userName

    -

    Properties

    -
    - -

    domain

    -
    domain: string
    - -
    -
    -

    Set the JMX domain under which to publish metrics

    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    enabled

    -
    enabled: boolean
    - -
    -
    -

    Set true to enable Prometheus reporting

    -
    -
    +
    +
    +

    Methods

    +
    + +

    getDomain

    +
      +
    • getDomain(): string
      • +
    +
      +
    • + +
      +
      +

      Set the JMX domain under which to publish metrics

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    step

    -
    step: number
    - -
    -
    -

    Push interval steps, in seconds. Default is 10 seconds.

    -
    -
    +
    + +

    getStep

    +
      +
    • getStep(): number
      • +
    +
      +
    • + +
      +
      +

      Push interval steps, in seconds. Default is 10 seconds.

      +
      +
      +

      Returns number

      +
      • +
    +
    +
    + +

    isEnabled

    +
      +
    • isEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set true to enable Prometheus reporting

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    setDomain

    + +
      +
    • + +
      +
      +

      Set the JMX domain under which to publish metrics

      +
      +
      +

      Parameters

      +
        +
      • +
        domain: string
        +
        • +
      +

      Returns VertxJmxMetricsOptions

      +
      • +
    +
    +
    + +

    setEnabled

    + +
      +
    • + +
      +
      +

      Set true to enable Prometheus reporting

      +
      +
      +

      Parameters

      +
        +
      • +
        enabled: boolean
        +
        • +
      +

      Returns VertxJmxMetricsOptions

      +
      • +
    +
    +
    + +

    setStep

    + +
      +
    • + +
      +
      +

      Push interval steps, in seconds. Default is 10 seconds.

      +
      +
      +

      Parameters

      +
        +
      • +
        step: number
        +
        • +
      +

      Returns VertxJmxMetricsOptions

      +
      • +
    @@ -146,6 +295,12 @@

    step

    -

    Properties

    -
    - -

    embeddedServerEndpoint

    -
    embeddedServerEndpoint: string
    - -
    -
    -

    Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.

    -
    -
    -
    param
    -

    metrics endpoint

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    embeddedServerOptions

    -
    embeddedServerOptions: HttpServerOptions
    - -
    -
    -

    HTTP server options for the embedded server

    -
    -
    -
    param
    -

    the server options

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getEmbeddedServerEndpoint

    +
      +
    • getEmbeddedServerEndpoint(): string
      • +
    +
      +
    • + +
      +
      +

      Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    enabled

    -
    enabled: boolean
    - -
    -
    -

    Set true to enable Prometheus reporting

    -
    -
    +
    + +

    getEmbeddedServerOptions

    +
      +
    • getEmbeddedServerOptions(): HttpServerOptions
      • +
    +
      +
    • + +
      +
      +

      HTTP server options for the embedded server

      +
      +
      +

      Returns HttpServerOptions

      +
      • +
    -
    - -

    startEmbeddedServer

    -
    startEmbeddedServer: boolean
    - -
    -
    -

    When true, an embedded server will start to expose metrics with Prometheus format.

    -
    -
    +
    + +

    isEnabled

    +
      +
    • isEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set true to enable Prometheus reporting

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isPublishQuantiles

    +
      +
    • isPublishQuantiles(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set true to publish histogram stats, necessary to compute quantiles. + Note that it generates many new timeseries for stats, which is why it is deactivated by default.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isStartEmbeddedServer

    +
      +
    • isStartEmbeddedServer(): boolean
      • +
    +
      +
    • + +
      +
      +

      When true, an embedded server will init to expose metrics with Prometheus format.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    setEmbeddedServerEndpoint

    + +
      +
    • + +
      +
      +

      Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.

      +
      +
      +

      Parameters

      +
        +
      • +
        embeddedServerEndpoint: string
        +
        +

        metrics endpoint

        +
        +
        • +
      +

      Returns VertxPrometheusOptions

      +
      • +
    +
    +
    + +

    setEmbeddedServerOptions

    + +
      +
    • + +
      +
      +

      HTTP server options for the embedded server

      +
      +
      +

      Parameters

      +
        +
      • +
        embeddedServerOptions: HttpServerOptions
        +
        +

        the server options

        +
        +
        • +
      +

      Returns VertxPrometheusOptions

      +
      • +
    +
    +
    + +

    setEnabled

    + +
      +
    • + +
      +
      +

      Set true to enable Prometheus reporting

      +
      +
      +

      Parameters

      +
        +
      • +
        enabled: boolean
        +
        • +
      +

      Returns VertxPrometheusOptions

      +
      • +
    +
    +
    + +

    setPublishQuantiles

    + +
      +
    • + +
      +
      +

      Set true to publish histogram stats, necessary to compute quantiles. + Note that it generates many new timeseries for stats, which is why it is deactivated by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        publishQuantiles: boolean
        +
        +

        the publishing quantiles flag

        +
        +
        • +
      +

      Returns VertxPrometheusOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setStartEmbeddedServer

    + +
      +
    • + +
      +
      +

      When true, an embedded server will init to expose metrics with Prometheus format.

      +
      +
      +

      Parameters

      +
        +
      • +
        startEmbeddedServer: boolean
        +
        • +
      +

      Returns VertxPrometheusOptions

      +
      • +
    @@ -172,6 +412,12 @@

    startEmbeddedServer

    diff --git a/docs/@vertx/mongo-client/classes/mongoclientupdateresult.html b/docs/@vertx/micrometer-metrics/enums/matchtype.html similarity index 71% rename from docs/@vertx/mongo-client/classes/mongoclientupdateresult.html rename to docs/@vertx/micrometer-metrics/enums/matchtype.html index cb2f905d6..855c6e3ba 100644 --- a/docs/@vertx/mongo-client/classes/mongoclientupdateresult.html +++ b/docs/@vertx/micrometer-metrics/enums/matchtype.html @@ -3,7 +3,7 @@ - MongoClientUpdateResult | @vertx/mongo-client + MatchType | @vertx/micrometer-metrics @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/mongo-client + @vertx/micrometer-metrics
    @@ -54,23 +54,52 @@ Globals
  • - MongoClientUpdateResult + MatchType
    • -

    Class MongoClientUpdateResult

    +

    Enumeration MatchType

    -
    -

    Hierarchy

    -
      -
    • - MongoClientUpdateResult -
      • -
    +
    +

    Index

    +
    +
    +
    +

    Enumeration members

    + +
    +
    +
    +
    +
    +

    Enumeration members

    +
    + +

    EQUALS

    +
    EQUALS:
    + +
    +
    + +

    REGEX

    +
    REGEX:
    + +
    @@ -83,36 +112,47 @@

    Hierarchy

    diff --git a/docs/@vertx/micrometer-metrics/enums/metricsdomain.html b/docs/@vertx/micrometer-metrics/enums/metricsdomain.html index 79a3568af..461db451d 100644 --- a/docs/@vertx/micrometer-metrics/enums/metricsdomain.html +++ b/docs/@vertx/micrometer-metrics/enums/metricsdomain.html @@ -92,7 +92,7 @@

    DATAGRAM_SOCKET

    DATAGRAM_SOCKET:
    @@ -102,7 +102,7 @@

    EVENT_BUS

    EVENT_BUS:
    @@ -112,7 +112,7 @@

    HTTP_CLIENT

    HTTP_CLIENT:
    @@ -122,7 +122,7 @@

    HTTP_SERVER

    HTTP_SERVER:
    @@ -132,7 +132,7 @@

    NAMED_POOLS

    NAMED_POOLS:
    @@ -142,7 +142,7 @@

    NET_CLIENT

    NET_CLIENT:
    @@ -152,7 +152,7 @@

    NET_SERVER

    NET_SERVER:
    @@ -162,7 +162,7 @@

    VERTICLES

    VERTICLES:
    @@ -178,6 +178,12 @@

    VERTICLES

    @@ -77,110 +77,79 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    multi

    -
    multi: boolean
    - -
    -
    -

    Set whether multi is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    -
    -
    - -

    returningNewDocument

    -
    returningNewDocument: boolean
    - -
    -
    -

    Set whether new document property is enabled. Valid only on findOneAnd* methods.

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    -
    -
    - -

    upsert

    -
    upsert: boolean
    - -
    -
    -

    Set whether upsert is enabled

    -
    -
    -
    param
    -

    true if enabled

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    writeOption

    -
    writeOption: WriteOption
    - -
    -
    -

    Set the write option

    -
    -
    -
    param
    -

    the write option

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getRemovedCount

    +
      +
    • getRemovedCount(): number
      • +
    +
      +
    • + +
      +
      +

      Get the number of removed documents

      +
      +
      +

      Returns number

      +

      number of removed documents

      +
      • +
    @@ -194,6 +163,9 @@

    writeOption

    diff --git a/docs/@vertx/mongo-client/classes/bulkoperation.html b/docs/@vertx/mongo/classes/mongoclientupdateresult.html similarity index 55% rename from docs/@vertx/mongo-client/classes/bulkoperation.html rename to docs/@vertx/mongo/classes/mongoclientupdateresult.html index 208b24504..84d4ce61a 100644 --- a/docs/@vertx/mongo-client/classes/bulkoperation.html +++ b/docs/@vertx/mongo/classes/mongoclientupdateresult.html @@ -3,7 +3,7 @@ - BulkOperation | @vertx/mongo-client + MongoClientUpdateResult | @vertx/mongo @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/mongo-client + @vertx/mongo
    @@ -54,10 +54,10 @@ Globals
  • - BulkOperation + MongoClientUpdateResult
    • -

    Class BulkOperation

    +

    Class MongoClientUpdateResult

    @@ -68,7 +68,7 @@

    Class BulkOperation

    Hierarchy

    • - BulkOperation + MongoClientUpdateResult
    @@ -77,129 +77,132 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    document

    -
    document: object
    - -
    -
    -

    Sets the document, used by insert, replace, and update operations

    -
    -
    -
    param
    - 
          the document
    -
    returns
    -

    this for fluency

    -
    -
    -
    -
    -
    - -

    filter

    -
    filter: object
    - -
    -
    -

    Sets the filter document, used by replace, update, and delete operations

    -
    -
    -
    param
    - 
          the filter document
    -
    returns
    -

    this for fluency

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    multi

    -
    multi: boolean
    - -
    -
    -

    Sets the multi flag, used by update and delete operations

    -
    -
    -
    param
    - 
          the mutli flag
    -
    returns
    -

    this for fluency

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getDocMatched

    +
      +
    • getDocMatched(): number
      • +
    +
      +
    • + +
      +
      +

      Get the number of documents that're matched

      +
      +
      +

      Returns number

      +

      number of documents that're matched

      +
      • +
    -
    - -

    type

    -
    type: BulkOperationType
    - -
    -
    -

    Sets the operation type

    -
    -
    -
    param
    - 
          the operation type
    -
    returns
    -

    this for fluency

    -
    -
    -
    +
    + +

    getDocModified

    +
      +
    • getDocModified(): number
      • +
    +
      +
    • + +
      +
      +

      Get the number of documents that're modified

      +
      +
      +

      Returns number

      +

      number of documents that're modified

      +
      • +
    -
    - -

    upsert

    -
    upsert: boolean
    - -
    -
    -

    Sets the upsert flag, used by update and replace operations

    -
    -
    -
    param
    - 
          the upsert flag
    -
    returns
    -

    this for fluency

    -
    -
    -
    +
    + +

    getDocUpsertedId

    +
      +
    • getDocUpsertedId(): object
      • +
    +
      +
    • + +
      +
      +

      Get the document id that's upserted

      +
      +
      +

      Returns object

      +

      document id that's upserted

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    @@ -213,30 +216,12 @@

    upsert

    @@ -98,7 +111,7 @@

    querySingle

  • Parameters

    @@ -111,17 +124,20 @@
    handler: function
      • -
      • (result: AsyncResult<any[]>): void
        • +
      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

      • Parameters

        • -
          result: AsyncResult<any[]>
          +
          res: AsyncResult<any[]>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<any[]>> +

      • @@ -142,7 +158,7 @@

      querySingleWithParams

    • Parameters

      @@ -158,17 +174,20 @@
      handler: function
        • -
        • (result: AsyncResult<any[]>): void
          • +
        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

        • Parameters

          • -
            result: AsyncResult<any[]>
            +
            res: AsyncResult<any[]>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<any[]>> +

        • diff --git a/docs/@vertx/mysql-postgresql-client/classes/mysqlclient.html b/docs/@vertx/mysql-postgresql-client/classes/mysqlclient.html index d737c5a7e..67e914f16 100644 --- a/docs/@vertx/mysql-postgresql-client/classes/mysqlclient.html +++ b/docs/@vertx/mysql-postgresql-client/classes/mysqlclient.html @@ -68,7 +68,12 @@

        Class MySQLClient

        Hierarchy

    • @@ -79,8 +84,8 @@

    Index

    Methods

    @@ -90,17 +95,18 @@

    Methods

    Methods

    -
    +

    querySingle

    -
      +
      • querySingle(sql: string, handler: function): SQLOperations

      • Parameters

        @@ -113,17 +119,20 @@
        handler: function
          • -
          • (result: AsyncResult<any[]>): void
            • +
          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

          • Parameters

            • -
              result: AsyncResult<any[]>
              +
              res: AsyncResult<any[]>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<any[]>> +

          • @@ -134,17 +143,18 @@

          Returns SQLOperat

    -
    +

    querySingleWithParams

    -
    @@ -79,8 +84,8 @@

    Index

    Methods

    @@ -90,17 +95,18 @@

    Methods

    Methods

    -
    +

    querySingle

    -
      +
      • querySingle(sql: string, handler: function): SQLOperations

      • Parameters

        @@ -113,17 +119,20 @@
        handler: function
          • -
          • (result: AsyncResult<any[]>): void
            • +
          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

          • Parameters

            • -
              result: AsyncResult<any[]>
              +
              res: AsyncResult<any[]>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<any[]>> +

          • @@ -134,17 +143,18 @@

          Returns SQLOperat

    -
    +

    querySingleWithParams

    -
      +
      • querySingleWithParams(sql: string, arguments: any[], handler: function): SQLOperations

      Returns AsyncSQLClient

      @@ -316,10 +344,10 @@

      Returns PostgreSQLClient
        -
      • +
      • querySingle
        • -
      • +
      • querySingleWithParams
      • diff --git a/docs/@vertx/rabbitmq-client/assets/js/search.js b/docs/@vertx/rabbitmq-client/assets/js/search.js index ed453b72b..c650f3c02 100644 --- a/docs/@vertx/rabbitmq-client/assets/js/search.js +++ b/docs/@vertx/rabbitmq-client/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"RabbitMQOptions","url":"classes/rabbitmqoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"automaticRecoveryEnabled","url":"classes/rabbitmqoptions.html#automaticrecoveryenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":2,"kind":1024,"name":"connectionRetries","url":"classes/rabbitmqoptions.html#connectionretries","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":3,"kind":1024,"name":"connectionRetryDelay","url":"classes/rabbitmqoptions.html#connectionretrydelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":4,"kind":1024,"name":"connectionTimeout","url":"classes/rabbitmqoptions.html#connectiontimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":5,"kind":1024,"name":"handshakeTimeout","url":"classes/rabbitmqoptions.html#handshaketimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":6,"kind":1024,"name":"host","url":"classes/rabbitmqoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":7,"kind":1024,"name":"includeProperties","url":"classes/rabbitmqoptions.html#includeproperties","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":8,"kind":1024,"name":"networkRecoveryInterval","url":"classes/rabbitmqoptions.html#networkrecoveryinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":9,"kind":1024,"name":"password","url":"classes/rabbitmqoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":10,"kind":1024,"name":"port","url":"classes/rabbitmqoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":11,"kind":1024,"name":"requestedChannelMax","url":"classes/rabbitmqoptions.html#requestedchannelmax","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":12,"kind":1024,"name":"requestedHeartbeat","url":"classes/rabbitmqoptions.html#requestedheartbeat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":13,"kind":1024,"name":"uri","url":"classes/rabbitmqoptions.html#uri","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":14,"kind":1024,"name":"user","url":"classes/rabbitmqoptions.html#user","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":15,"kind":1024,"name":"virtualHost","url":"classes/rabbitmqoptions.html#virtualhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":16,"kind":128,"name":"RabbitMQClient","url":"classes/rabbitmqclient.html","classes":"tsd-kind-class"},{"id":17,"kind":2048,"name":"create","url":"classes/rabbitmqclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RabbitMQClient"},{"id":18,"kind":2048,"name":"basicAck","url":"classes/rabbitmqclient.html#basicack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":19,"kind":2048,"name":"basicNack","url":"classes/rabbitmqclient.html#basicnack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":20,"kind":2048,"name":"basicGet","url":"classes/rabbitmqclient.html#basicget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":21,"kind":2048,"name":"basicConsume","url":"classes/rabbitmqclient.html#basicconsume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":22,"kind":2048,"name":"basicPublish","url":"classes/rabbitmqclient.html#basicpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":23,"kind":2048,"name":"confirmSelect","url":"classes/rabbitmqclient.html#confirmselect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":24,"kind":2048,"name":"waitForConfirms","url":"classes/rabbitmqclient.html#waitforconfirms","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":25,"kind":2048,"name":"basicQos","url":"classes/rabbitmqclient.html#basicqos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":26,"kind":2048,"name":"exchangeDeclare","url":"classes/rabbitmqclient.html#exchangedeclare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":27,"kind":2048,"name":"exchangeDelete","url":"classes/rabbitmqclient.html#exchangedelete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":28,"kind":2048,"name":"exchangeBind","url":"classes/rabbitmqclient.html#exchangebind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":29,"kind":2048,"name":"exchangeUnbind","url":"classes/rabbitmqclient.html#exchangeunbind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":30,"kind":2048,"name":"queueDeclareAuto","url":"classes/rabbitmqclient.html#queuedeclareauto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":31,"kind":2048,"name":"queueDeclare","url":"classes/rabbitmqclient.html#queuedeclare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":32,"kind":2048,"name":"queueDelete","url":"classes/rabbitmqclient.html#queuedelete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":33,"kind":2048,"name":"queueDeleteIf","url":"classes/rabbitmqclient.html#queuedeleteif","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":34,"kind":2048,"name":"queueBind","url":"classes/rabbitmqclient.html#queuebind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":35,"kind":2048,"name":"messageCount","url":"classes/rabbitmqclient.html#messagecount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":36,"kind":2048,"name":"start","url":"classes/rabbitmqclient.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":37,"kind":2048,"name":"stop","url":"classes/rabbitmqclient.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":38,"kind":2048,"name":"isConnected","url":"classes/rabbitmqclient.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":39,"kind":2048,"name":"isOpenChannel","url":"classes/rabbitmqclient.html#isopenchannel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"QueueOptions","url":"classes/queueoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/queueoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"QueueOptions"},{"id":2,"kind":2048,"name":"isAutoAck","url":"classes/queueoptions.html#isautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QueueOptions"},{"id":3,"kind":2048,"name":"setAutoAck","url":"classes/queueoptions.html#setautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QueueOptions"},{"id":4,"kind":2048,"name":"isKeepMostRecent","url":"classes/queueoptions.html#iskeepmostrecent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QueueOptions"},{"id":5,"kind":2048,"name":"setKeepMostRecent","url":"classes/queueoptions.html#setkeepmostrecent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QueueOptions"},{"id":6,"kind":2048,"name":"maxInternalQueueSize","url":"classes/queueoptions.html#maxinternalqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QueueOptions"},{"id":7,"kind":2048,"name":"setMaxInternalQueueSize","url":"classes/queueoptions.html#setmaxinternalqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QueueOptions"},{"id":8,"kind":128,"name":"RabbitMQOptions","url":"classes/rabbitmqoptions.html","classes":"tsd-kind-class"},{"id":9,"kind":512,"name":"constructor","url":"classes/rabbitmqoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":10,"kind":2048,"name":"isAutomaticRecoveryEnabled","url":"classes/rabbitmqoptions.html#isautomaticrecoveryenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":11,"kind":2048,"name":"setAutomaticRecoveryEnabled","url":"classes/rabbitmqoptions.html#setautomaticrecoveryenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":12,"kind":2048,"name":"getConnectionRetries","url":"classes/rabbitmqoptions.html#getconnectionretries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":13,"kind":2048,"name":"setConnectionRetries","url":"classes/rabbitmqoptions.html#setconnectionretries","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":14,"kind":2048,"name":"getConnectionRetryDelay","url":"classes/rabbitmqoptions.html#getconnectionretrydelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":15,"kind":2048,"name":"setConnectionRetryDelay","url":"classes/rabbitmqoptions.html#setconnectionretrydelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":16,"kind":2048,"name":"getConnectionTimeout","url":"classes/rabbitmqoptions.html#getconnectiontimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":17,"kind":2048,"name":"setConnectionTimeout","url":"classes/rabbitmqoptions.html#setconnectiontimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":18,"kind":2048,"name":"getHandshakeTimeout","url":"classes/rabbitmqoptions.html#gethandshaketimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":19,"kind":2048,"name":"setHandshakeTimeout","url":"classes/rabbitmqoptions.html#sethandshaketimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":20,"kind":2048,"name":"getHost","url":"classes/rabbitmqoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":21,"kind":2048,"name":"setHost","url":"classes/rabbitmqoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":22,"kind":2048,"name":"getIncludeProperties","url":"classes/rabbitmqoptions.html#getincludeproperties","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":23,"kind":2048,"name":"setIncludeProperties","url":"classes/rabbitmqoptions.html#setincludeproperties","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":24,"kind":2048,"name":"getNetworkRecoveryInterval","url":"classes/rabbitmqoptions.html#getnetworkrecoveryinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":25,"kind":2048,"name":"setNetworkRecoveryInterval","url":"classes/rabbitmqoptions.html#setnetworkrecoveryinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":26,"kind":2048,"name":"getPassword","url":"classes/rabbitmqoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":27,"kind":2048,"name":"setPassword","url":"classes/rabbitmqoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":28,"kind":2048,"name":"getPort","url":"classes/rabbitmqoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":29,"kind":2048,"name":"setPort","url":"classes/rabbitmqoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":30,"kind":2048,"name":"getRequestedChannelMax","url":"classes/rabbitmqoptions.html#getrequestedchannelmax","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":31,"kind":2048,"name":"setRequestedChannelMax","url":"classes/rabbitmqoptions.html#setrequestedchannelmax","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":32,"kind":2048,"name":"getRequestedHeartbeat","url":"classes/rabbitmqoptions.html#getrequestedheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":33,"kind":2048,"name":"setRequestedHeartbeat","url":"classes/rabbitmqoptions.html#setrequestedheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":34,"kind":2048,"name":"getUri","url":"classes/rabbitmqoptions.html#geturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":35,"kind":2048,"name":"setUri","url":"classes/rabbitmqoptions.html#seturi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":36,"kind":2048,"name":"getUser","url":"classes/rabbitmqoptions.html#getuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":37,"kind":2048,"name":"setUser","url":"classes/rabbitmqoptions.html#setuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":38,"kind":2048,"name":"getVirtualHost","url":"classes/rabbitmqoptions.html#getvirtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":39,"kind":2048,"name":"setVirtualHost","url":"classes/rabbitmqoptions.html#setvirtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQOptions"},{"id":40,"kind":128,"name":"BasicProperties","url":"classes/basicproperties.html","classes":"tsd-kind-class"},{"id":41,"kind":2048,"name":"contentType","url":"classes/basicproperties.html#contenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":42,"kind":2048,"name":"contentEncoding","url":"classes/basicproperties.html#contentencoding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":43,"kind":2048,"name":"deliveryMode","url":"classes/basicproperties.html#deliverymode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":44,"kind":2048,"name":"priority","url":"classes/basicproperties.html#priority","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":45,"kind":2048,"name":"correlationId","url":"classes/basicproperties.html#correlationid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":46,"kind":2048,"name":"replyTo","url":"classes/basicproperties.html#replyto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":47,"kind":2048,"name":"expiration","url":"classes/basicproperties.html#expiration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":48,"kind":2048,"name":"messageId","url":"classes/basicproperties.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":49,"kind":2048,"name":"timestamp","url":"classes/basicproperties.html#timestamp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":50,"kind":2048,"name":"type","url":"classes/basicproperties.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":51,"kind":2048,"name":"userId","url":"classes/basicproperties.html#userid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":52,"kind":2048,"name":"appId","url":"classes/basicproperties.html#appid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":53,"kind":2048,"name":"clusterId","url":"classes/basicproperties.html#clusterid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BasicProperties"},{"id":54,"kind":128,"name":"Envelope","url":"classes/envelope.html","classes":"tsd-kind-class"},{"id":55,"kind":2048,"name":"deliveryTag","url":"classes/envelope.html#deliverytag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Envelope"},{"id":56,"kind":2048,"name":"isRedelivery","url":"classes/envelope.html#isredelivery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Envelope"},{"id":57,"kind":2048,"name":"exchange","url":"classes/envelope.html#exchange","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Envelope"},{"id":58,"kind":2048,"name":"routingKey","url":"classes/envelope.html#routingkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Envelope"},{"id":59,"kind":128,"name":"RabbitMQClient","url":"classes/rabbitmqclient.html","classes":"tsd-kind-class"},{"id":60,"kind":2048,"name":"create","url":"classes/rabbitmqclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RabbitMQClient"},{"id":61,"kind":2048,"name":"basicAck","url":"classes/rabbitmqclient.html#basicack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":62,"kind":2048,"name":"basicNack","url":"classes/rabbitmqclient.html#basicnack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":63,"kind":2048,"name":"basicGet","url":"classes/rabbitmqclient.html#basicget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":64,"kind":2048,"name":"basicConsume","url":"classes/rabbitmqclient.html#basicconsume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":65,"kind":2048,"name":"basicCancel","url":"classes/rabbitmqclient.html#basiccancel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":66,"kind":2048,"name":"basicConsumer","url":"classes/rabbitmqclient.html#basicconsumer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":67,"kind":2048,"name":"basicPublish","url":"classes/rabbitmqclient.html#basicpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":68,"kind":2048,"name":"confirmSelect","url":"classes/rabbitmqclient.html#confirmselect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":69,"kind":2048,"name":"waitForConfirms","url":"classes/rabbitmqclient.html#waitforconfirms","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":70,"kind":2048,"name":"basicQos","url":"classes/rabbitmqclient.html#basicqos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":71,"kind":2048,"name":"exchangeDeclare","url":"classes/rabbitmqclient.html#exchangedeclare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":72,"kind":2048,"name":"exchangeDelete","url":"classes/rabbitmqclient.html#exchangedelete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":73,"kind":2048,"name":"exchangeBind","url":"classes/rabbitmqclient.html#exchangebind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":74,"kind":2048,"name":"exchangeUnbind","url":"classes/rabbitmqclient.html#exchangeunbind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":75,"kind":2048,"name":"queueDeclareAuto","url":"classes/rabbitmqclient.html#queuedeclareauto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":76,"kind":2048,"name":"queueDeclare","url":"classes/rabbitmqclient.html#queuedeclare","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":77,"kind":2048,"name":"queueDelete","url":"classes/rabbitmqclient.html#queuedelete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":78,"kind":2048,"name":"queueDeleteIf","url":"classes/rabbitmqclient.html#queuedeleteif","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":79,"kind":2048,"name":"queueBind","url":"classes/rabbitmqclient.html#queuebind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":80,"kind":2048,"name":"messageCount","url":"classes/rabbitmqclient.html#messagecount","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":81,"kind":2048,"name":"start","url":"classes/rabbitmqclient.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":82,"kind":2048,"name":"stop","url":"classes/rabbitmqclient.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":83,"kind":2048,"name":"isConnected","url":"classes/rabbitmqclient.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":84,"kind":2048,"name":"isOpenChannel","url":"classes/rabbitmqclient.html#isopenchannel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQClient"},{"id":85,"kind":128,"name":"RabbitMQConsumer","url":"classes/rabbitmqconsumer.html","classes":"tsd-kind-class"},{"id":86,"kind":2048,"name":"fetch","url":"classes/rabbitmqconsumer.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":87,"kind":2048,"name":"exceptionHandler","url":"classes/rabbitmqconsumer.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":88,"kind":2048,"name":"handler","url":"classes/rabbitmqconsumer.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":89,"kind":2048,"name":"pause","url":"classes/rabbitmqconsumer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":90,"kind":2048,"name":"resume","url":"classes/rabbitmqconsumer.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":91,"kind":2048,"name":"endHandler","url":"classes/rabbitmqconsumer.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":92,"kind":2048,"name":"consumerTag","url":"classes/rabbitmqconsumer.html#consumertag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":93,"kind":2048,"name":"cancel","url":"classes/rabbitmqconsumer.html#cancel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":94,"kind":2048,"name":"isPaused","url":"classes/rabbitmqconsumer.html#ispaused","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQConsumer"},{"id":95,"kind":128,"name":"RabbitMQMessage","url":"classes/rabbitmqmessage.html","classes":"tsd-kind-class"},{"id":96,"kind":2048,"name":"body","url":"classes/rabbitmqmessage.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQMessage"},{"id":97,"kind":2048,"name":"consumerTag","url":"classes/rabbitmqmessage.html#consumertag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQMessage"},{"id":98,"kind":2048,"name":"envelope","url":"classes/rabbitmqmessage.html#envelope","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQMessage"},{"id":99,"kind":2048,"name":"properties","url":"classes/rabbitmqmessage.html#properties","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RabbitMQMessage"}]}; \ No newline at end of file diff --git a/docs/@vertx/rabbitmq-client/classes/basicproperties.html b/docs/@vertx/rabbitmq-client/classes/basicproperties.html new file mode 100644 index 000000000..938cb45ae --- /dev/null +++ b/docs/@vertx/rabbitmq-client/classes/basicproperties.html @@ -0,0 +1,514 @@ + + + + + + BasicProperties | @vertx/rabbitmq-client + + + + + +
        +
        +
        +
        + +
        +
        + Options +
        +
        + All +
          +
        • Public
          • +
        • Public/Protected
          • +
        • All
          • +
        +
        + + + + +
        +
        + Menu +
        +
        +
        +
        +
        +
        + +

        Class BasicProperties

        +
        +
        +
        +
        +
        +
        +
        +

        Hierarchy

        +
          +
        • + BasicProperties +
          • +
        +
        +
        +

        Index

        +
        +
        +
        +

        Methods

        + +
        +
        +
        +
        +
        +

        Methods

        +
        + +

        appId

        +
          +
        • appId(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          appId, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        clusterId

        +
          +
        • clusterId(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          clusterId, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        contentEncoding

        +
          +
        • contentEncoding(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          contentEncoding of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        contentType

        +
          +
        • contentType(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          contentType of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        correlationId

        +
          +
        • correlationId(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          correlationId of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        deliveryMode

        +
          +
        • deliveryMode(): number
          • +
        +
          +
        • + +
          +
          +

          Returns number

          +

          deliveryMode of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        expiration

        +
          +
        • expiration(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          expiration of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        messageId

        +
          +
        • messageId(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          messageId, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        priority

        +
          +
        • priority(): number
          • +
        +
          +
        • + +
          +
          +

          Retrieve the value in the priority field.

          +
          +
          +

          Returns number

          +

          priority of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        replyTo

        +
          +
        • replyTo(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          replyTo address, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        timestamp

        +
          +
        • timestamp(): number
          • +
        +
          +
        • + +
          +
          +

          Returns number

          +

          timestamp of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        type

        +
          +
        • type(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          type of a message, or {@code null} if it has not been set.

          +
          • +
        +
        +
        + +

        userId

        +
          +
        • userId(): string
          • +
        +
          +
        • + +
          +
          +

          Returns string

          +

          userId, or {@code null} if it has not been set.

          +
          • +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Legend

        +
        +
          +
        • Module
          • +
        • Object literal
          • +
        • Variable
          • +
        • Function
          • +
        • Function with type parameter
          • +
        • Index signature
          • +
        • Type alias
          • +
        +
          +
        • Enumeration
          • +
        • Enumeration member
          • +
        • Property
          • +
        • Method
          • +
        +
          +
        • Interface
          • +
        • Interface with type parameter
          • +
        • Constructor
          • +
        • Property
          • +
        • Method
          • +
        • Index signature
          • +
        +
          +
        • Class
          • +
        • Class with type parameter
          • +
        • Constructor
          • +
        • Property
          • +
        • Method
          • +
        • Accessor
          • +
        • Index signature
          • +
        +
          +
        • Inherited constructor
          • +
        • Inherited property
          • +
        • Inherited method
          • +
        • Inherited accessor
          • +
        +
          +
        • Protected property
          • +
        • Protected method
          • +
        • Protected accessor
          • +
        +
          +
        • Private property
          • +
        • Private method
          • +
        • Private accessor
          • +
        +
          +
        • Static property
          • +
        • Static method
          • +
        +
        +
        +
        +
        +

        Generated using TypeDoc

        +
        +
        + + + + \ No newline at end of file diff --git a/docs/@vertx/redis-client/classes/bitfieldsetcommand.html b/docs/@vertx/rabbitmq-client/classes/envelope.html similarity index 57% rename from docs/@vertx/redis-client/classes/bitfieldsetcommand.html rename to docs/@vertx/rabbitmq-client/classes/envelope.html index 5d5774f99..6a8938357 100644 --- a/docs/@vertx/redis-client/classes/bitfieldsetcommand.html +++ b/docs/@vertx/rabbitmq-client/classes/envelope.html @@ -3,7 +3,7 @@ - BitFieldSetCommand | @vertx/redis-client + Envelope | @vertx/rabbitmq-client @@ -22,7 +22,7 @@
      • Preparing search index...
      • The search index is not available
      - @vertx/redis-client + @vertx/rabbitmq-client
      @@ -54,10 +54,10 @@ Globals
    • - BitFieldSetCommand + Envelope

    -

    Class BitFieldSetCommand

    +

    Class Envelope

    @@ -68,7 +68,7 @@

    Class BitFieldSetCommand

    Hierarchy

    • - BitFieldSetCommand + Envelope
    @@ -77,47 +77,113 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    offset

    -
    offset: number
    - +

    Methods

    +
    + +

    deliveryTag

    +
      +
    • deliveryTag(): number
      • +
    +
      +
    • + +
      +
      +

      Get the delivery tag included in this parameter envelope

      +
      +
      +

      Returns number

      +

      the delivery tag

      +
      • +
    -
    - -

    type

    -
    type: string
    - +
    + +

    exchange

    +
      +
    • exchange(): string
      • +
    +
      +
    • + +
      +
      +

      Get the name of the exchange included in this parameter envelope

      +
      +
      +

      Returns string

      +

      the exchange

      +
      • +
    -
    - -

    value

    -
    value: number
    - +
    + +

    isRedelivery

    +
      +
    • isRedelivery(): boolean
      • +
    +
      +
    • + +
      +
      +

      Get the redelivery flag included in this parameter envelope. This is a + hint as to whether this message may have been delivered before (but not + acknowledged). If the flag is not set, the message definitely has not + been delivered before. If it is set, it may have been delivered before.

      +
      +
      +

      Returns boolean

      +

      the redelivery flag

      +
      • +
    +
    +
    + +

    routingKey

    +
      +
    • routingKey(): string
      • +
    +
      +
    • + +
      +
      +

      Get the routing key included in this parameter envelope

      +
      +
      +

      Returns string

      +

      the routing key

      +
      • +
    @@ -131,113 +197,44 @@

    value

    diff --git a/docs/@vertx/rabbitmq-client/classes/queueoptions.html b/docs/@vertx/rabbitmq-client/classes/queueoptions.html new file mode 100644 index 000000000..d6e255789 --- /dev/null +++ b/docs/@vertx/rabbitmq-client/classes/queueoptions.html @@ -0,0 +1,411 @@ + + + + + + QueueOptions | @vertx/rabbitmq-client + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class QueueOptions

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + QueueOptions +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    isAutoAck

    +
      +
    • isAutoAck(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isKeepMostRecent

    +
      +
    • isKeepMostRecent(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    maxInternalQueueSize

    +
      +
    • maxInternalQueueSize(): number
      • +
    +
      +
    • + +
      +
      +

      Returns number

      +
      • +
    +
    +
    + +

    setAutoAck

    + +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • +
        autoAck: boolean
        +
        +

        true if the server should consider messages + acknowledged once delivered; false if the server should expect + explicit acknowledgements

        +
        +
        • +
      +

      Returns QueueOptions

      +
      • +
    +
    +
    + +

    setKeepMostRecent

    +
      +
    • setKeepMostRecent(keepMostRecent: boolean): QueueOptions
      • +
    +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • +
        keepMostRecent: boolean
        +
        +

        for discarding old messages instead of recent ones, + otherwise use {@code false}

        +
        +
        • +
      +

      Returns QueueOptions

      +
      • +
    +
    +
    + +

    setMaxInternalQueueSize

    +
      +
    • setMaxInternalQueueSize(maxInternalQueueSize: number): QueueOptions
      • +
    +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • +
        maxInternalQueueSize: number
        +
        +

        the size of internal queue

        +
        +
        • +
      +

      Returns QueueOptions

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/rabbitmq-client/classes/rabbitmqclient.html b/docs/@vertx/rabbitmq-client/classes/rabbitmqclient.html index b3c533f44..92dad3a00 100644 --- a/docs/@vertx/rabbitmq-client/classes/rabbitmqclient.html +++ b/docs/@vertx/rabbitmq-client/classes/rabbitmqclient.html @@ -80,7 +80,9 @@

    Index

    Methods

    • basicAck
      • +
    • basicCancel
    • basicConsume
      • +
    • basicConsumer
    • basicGet
    • basicNack
    • basicPublish
      • @@ -119,12 +121,12 @@

      basicAck

    • -

      Acknowledge one or several received messages. Supply the deliveryTag from the AMQP.Basic.GetOk or AMQP.Basic.Deliver +

      Acknowledge one or several received messages. Supply the deliveryTag from the AMQP.Basic.GetOk or AMQP.Basic.Deliver method containing the received message being acknowledged.

      @@ -146,17 +148,110 @@
      resultHandler: function
        • -
        • (result: AsyncResult<any>): void
          • +
        • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            res: AsyncResult<object>
            +
            • +
          +

          Returns void + | + Handler<AsyncResult<object>> +

          +
          • +
        +
        • +
      +
      • +
    +

    Returns void

    + + +
    +
    + +

    basicCancel

    +
      +
    • basicCancel(consumerTag: string): void
      • +
    • basicCancel(consumerTag: string, resultHandler: function): void
      • +
    +
      +
    • + +
      +
      +

      Instead of using this and {@link #basicConsume(String, String, Handler)} method, + {@link #basicConsumer(String, QueueOptions, Handler)} and {@link RabbitMQConsumer#cancel(Handler)} instead +

      + This method should be called when you want to cancel consumption from a queue, + started by calling {@link #basicConsume(String, String, Handler)}.

      +
      +
      +
      see
      +

      Channel#basicCancel(String)

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        consumerTag: string
        +
        • +
      +

      Returns void

      +
      • +
    • + +
      +
      +

      Instead of using this and {@link #basicConsume(String, String, Handler)} method, + {@link #basicConsumer(String, QueueOptions, Handler)} and {@link RabbitMQConsumer#cancel(Handler)} instead +

      + This method should be called when you want to cancel consumption from a queue, + started by calling {@link #basicConsume(String, String, Handler)}.

      +
      +
      +
      see
      +

      Channel#basicCancel(String)

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        consumerTag: string
        +
        • +
      • +
        resultHandler: function
        +
          +
        • +
            +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

          • Parameters

            • -
              result: AsyncResult<any>
              +
              res: AsyncResult<void>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<void>> +

          • @@ -179,12 +274,14 @@

          basicConsume

        • -

          Start a non-nolocal, non-exclusive consumer, with auto acknowledgement and a server-generated consumerTag.

          +

          Use {@link RabbitMQClient#basicConsumer(String, QueueOptions, Handler)} instead +

          + Start a non-nolocal, non-exclusive consumer, with auto acknowledgement and a server-generated consumerTag.

          see
          @@ -205,17 +302,20 @@
          resultHandler: function
            • -
            • (result: AsyncResult<void>): void
              • +
            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

            • Parameters

              • -
                result: AsyncResult<void>
                +
                res: AsyncResult<string>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<string>> +

            • @@ -227,12 +327,14 @@

            Returns void
            -

            Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag.

            +

            Use {@link RabbitMQClient#basicConsumer(String, QueueOptions, Handler)} instead +

            + Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag.

            see
            @@ -256,17 +358,20 @@
            resultHandler: function
              • -
              • (result: AsyncResult<void>): void
                • +
              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

              • Parameters

                • -
                  result: AsyncResult<void>
                  +
                  res: AsyncResult<string>
                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<string>> +

              • @@ -278,12 +383,14 @@

              Returns void
              -

              Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag and error handler

              +

              Use {@link RabbitMQClient#basicConsumer(String, QueueOptions, Handler)} instead +

              + Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag and error handler

              see
              @@ -307,17 +414,20 @@
              resultHandler: function
                • -
                • (result: AsyncResult<void>): void
                  • +
                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                • Parameters

                  • -
                    result: AsyncResult<void>
                    +
                    res: AsyncResult<string>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<string>> +

                • @@ -328,17 +438,140 @@
                errorHandler: function
                  • -
                  • (result: Error): void
                    • +
                  • (res: Error): void | Handler<Error>
                    • +
                  +
                    +
                  • +

                    Parameters

                    +
                      +
                    • +
                      res: Error
                      +
                      • +
                    +

                    Returns void + | + Handler<Error> +

                    +
                    • +
                  +
                  • +
                + +
              +

              Returns void

              + +

            +

    +
    + +

    basicConsumer

    +
      +
    • basicConsumer(queue: string, resultHandler: function): void
      • +
    • basicConsumer(queue: string, options: QueueOptions, resultHandler: function): void
      • +
    +
      +
    • + +
      +
      +
      see
      +

      com.rabbitmq.client.Channel#basicConsume(String, Consumer)

      +
      +
      see
      +

      RabbitMQClient#basicConsumer(String, Handler)

      +
      +
      +
      +

      Parameters

      + +

      Returns void

      +
      • +
    • + +
      +
      +

      Create a consumer with the given {@code options}.

      +
      +
      +
      see
      +

      com.rabbitmq.client.Channel#basicConsume(String, boolean, String, Consumer)

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        queue: string
        +
        +

        the name of a queue

        +
        +
        • +
      • +
        options: QueueOptions
        +
        +

        options for queue

        +
        +
        • +
      • +
        resultHandler: function
        +
        +

        a handler through which you can find out the operation status; + if the operation succeeds you can begin to receive messages + through an instance of RabbitMQConsumer

        +
        +
          +
        • +
          • @@ -359,12 +592,12 @@

          basicGet

        • -

          Retrieve a message from a queue using AMQP.Basic.Get

          +

          Retrieve a message from a queue using AMQP.Basic.Get

          see
          @@ -385,17 +618,20 @@
          resultHandler: function
            • -
            • (result: AsyncResult<any>): void
              • +
            • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

            • Parameters

              • -
                result: AsyncResult<any>
                +
                res: AsyncResult<object>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<object>> +

            • @@ -416,12 +652,12 @@

            basicNack

          • -

            Reject one or several received messages.

            +

            Reject one or several received messages.

            see
            @@ -445,17 +681,20 @@
            resultHandler: function
              • -
              • (result: AsyncResult<any>): void
                • +
              • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

              • Parameters

                • -
                  result: AsyncResult<any>
                  +
                  res: AsyncResult<object>
                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<object>> +

              • @@ -476,12 +715,12 @@

              basicPublish

            • -

              Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, +

              Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

              @@ -500,23 +739,31 @@
              routingKey: string
            • message: object
              +
                +
              • +
                [key: string]: any
                +
                • +
            • resultHandler: function
                • -
                • (result: AsyncResult<void>): void
                  • +
                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                • Parameters

                  • -
                    result: AsyncResult<void>
                    +
                    res: AsyncResult<void>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<void>> +

                • @@ -532,22 +779,80 @@

                Returns voidbasicQos

                • basicQos(prefetchCount: number, resultHandler: function): void
                  • +
                • basicQos(prefetchCount: number, global: boolean, resultHandler: function): void
                  • +
                • basicQos(prefetchSize: number, prefetchCount: number, global: boolean, resultHandler: function): void
                • +
                  +
                  +

                  Request a specific prefetchCount "quality of service" settings + for this channel.

                  +
                  +
                  +
                  see
                  +

                  #basicQos(int, int, boolean, Handler)

                  +
                  +
                  +
                  +

                  Parameters

                  +
                    +
                  • +
                    prefetchCount: number
                    +
                    +

                    maximum number of messages that the server + will deliver, 0 if unlimited

                    +
                    +
                    • +
                  • +
                    resultHandler: function
                    +
                    +

                    handler called when operation is done with a result of the operation

                    +
                    +
                      +
                    • +
                        +
                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
                        • +
                      +
                        +
                      • +

                        Parameters

                        +
                          +
                        • +
                          res: AsyncResult<void>
                          +
                          • +
                        +

                        Returns void + | + Handler<AsyncResult<void>> +

                        +
                        • +
                      +
                      • +
                    +
                    • +
                  +

                  Returns void

                  +
                  • +
                • +
                  -

                  Request specific "quality of service" settings, Limiting the number of unacknowledged messages on - a channel (or connection). This limit is applied separately to each new consumer on the channel.

                  +

                  Request a specific prefetchCount "quality of service" settings + for this channel.

                  see
                  -

                  com.rabbitmq.client.Channel#basicQos(int)

                  +

                  #basicQos(int, int, boolean, Handler)

                  @@ -555,23 +860,112 @@

                  Parameters

                  • prefetchCount: number
                    +
                    +

                    maximum number of messages that the server + will deliver, 0 if unlimited

                    +
                    +
                    • +
                  • +
                    global: boolean
                    +
                    +

                    true if the settings should be applied to the + entire channel rather than each consumer

                    +
                  • resultHandler: function
                    +
                    +

                    handler called when operation is done with a result of the operation

                    +
                      • -
                      • (result: AsyncResult<void>): void
                        • +
                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                      • Parameters

                        • -
                          result: AsyncResult<void>
                          +
                          res: AsyncResult<void>
                        -

                        Returns void

                        +

                        Returns void + | + Handler<AsyncResult<void>> +

                        +
                        • +
                      +
                      • +
                    +
                    • +
                  +

                  Returns void

                  +
                  • +
                • + +
                  +
                  +

                  Request specific "quality of service" settings.

                  +
                  +

                  These settings impose limits on the amount of data the server + will deliver to consumers before requiring acknowledgements. + Thus they provide a means of consumer-initiated flow control.

                  +
                  +
                  see
                  +

                  com.rabbitmq.client.AMQP.Basic.Qos

                  +
                  +
                  +
                  +

                  Parameters

                  +
                    +
                  • +
                    prefetchSize: number
                    +
                    +

                    maximum amount of content (measured in + octets) that the server will deliver, 0 if unlimited

                    +
                    +
                    • +
                  • +
                    prefetchCount: number
                    +
                    +

                    maximum number of messages that the server + will deliver, 0 if unlimited

                    +
                    +
                    • +
                  • +
                    global: boolean
                    +
                    +

                    true if the settings should be applied to the + entire channel rather than each consumer

                    +
                    +
                    • +
                  • +
                    resultHandler: function
                    +
                    +

                    handler called when operation is done with a result of the operation

                    +
                    +
                      +
                    • +
                        +
                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
                        • +
                      +
                        +
                      • +

                        Parameters

                        +
                          +
                        • +
                          res: AsyncResult<void>
                          +
                          • +
                        +

                        Returns void + | + Handler<AsyncResult<void>> +

                      • @@ -592,12 +986,12 @@

                      confirmSelect

                    • -

                      Enables publisher acknowledgements on this channel. Can be called once during client initialisation. Calls to basicPublish() +

                      Enables publisher acknowledgements on this channel. Can be called once during client initialisation. Calls to basicPublish() will have to be confirmed.

                      @@ -616,17 +1010,20 @@
                      resultHandler: function
                        • -
                        • (result: AsyncResult<void>): void
                          • +
                        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                        • Parameters

                          • -
                            result: AsyncResult<void>
                            +
                            res: AsyncResult<void>
                          -

                          Returns void

                          +

                          Returns void + | + Handler<AsyncResult<void>> +

                        • @@ -647,12 +1044,12 @@

                        exchangeBind

                      • -

                        Bind an exchange to an exchange.

                        +

                        Bind an exchange to an exchange.

                        see
                        @@ -676,17 +1073,20 @@
                        resultHandler: function
                          • -
                          • (result: AsyncResult<void>): void
                            • +
                          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                          • Parameters

                            • -
                              result: AsyncResult<void>
                              +
                              res: AsyncResult<void>
                            -

                            Returns void

                            +

                            Returns void + | + Handler<AsyncResult<void>> +

                          • @@ -708,12 +1108,12 @@

                          exchangeDeclare

                        • -

                          Declare an exchange.

                          +

                          Declare an exchange.

                          see
                          @@ -740,17 +1140,20 @@
                          resultHandler: function
                            • -
                            • (result: AsyncResult<void>): void
                              • +
                            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                            • Parameters

                              • -
                                result: AsyncResult<void>
                                +
                                res: AsyncResult<void>
                              -

                              Returns void

                              +

                              Returns void + | + Handler<AsyncResult<void>> +

                            • @@ -762,12 +1165,12 @@

                            Returns void
                            -

                            Declare an exchange with additional parameters such as dead lettering, an alternate exchange or TTL.

                            +

                            Declare an exchange with additional parameters such as dead lettering, an alternate exchange or TTL.

                            see
                            @@ -791,23 +1194,31 @@
                            autoDelete: boolean
                          • config: object
                            +
                              +
                            • +
                              [key: string]: any
                              +
                              • +
                          • resultHandler: function
                              • -
                              • (result: AsyncResult<void>): void
                                • +
                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                              • Parameters

                                • -
                                  result: AsyncResult<void>
                                  +
                                  res: AsyncResult<void>
                                -

                                Returns void

                                +

                                Returns void + | + Handler<AsyncResult<void>> +

                              • @@ -828,12 +1239,12 @@

                              exchangeDelete

                            • -

                              Delete an exchange, without regard for whether it is in use or not.

                              +

                              Delete an exchange, without regard for whether it is in use or not.

                              see
                              @@ -851,17 +1262,20 @@
                              resultHandler: function
                                • -
                                • (result: AsyncResult<void>): void
                                  • +
                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                • Parameters

                                  • -
                                    result: AsyncResult<void>
                                    +
                                    res: AsyncResult<void>
                                  -

                                  Returns void

                                  +

                                  Returns void + | + Handler<AsyncResult<void>> +

                                • @@ -882,12 +1296,12 @@

                                exchangeUnbind

                              • -

                                Unbind an exchange from an exchange.

                                +

                                Unbind an exchange from an exchange.

                                see
                                @@ -911,17 +1325,20 @@
                                resultHandler: function
                                  • -
                                  • (result: AsyncResult<void>): void
                                    • +
                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                  • Parameters

                                    • -
                                      result: AsyncResult<void>
                                      +
                                      res: AsyncResult<void>
                                    -

                                    Returns void

                                    +

                                    Returns void + | + Handler<AsyncResult<void>> +

                                  • @@ -942,12 +1359,12 @@

                                  isConnected

                                • -

                                  Check if a connection is open

                                  +

                                  Check if a connection is open

                                  see
                                  @@ -970,12 +1387,12 @@

                                  isOpenChannel

                                • -

                                  Check if a channel is open

                                  +

                                  Check if a channel is open

                                  see
                                  @@ -998,12 +1415,12 @@

                                  messageCount

                                • -

                                  Returns the number of messages in a queue ready to be delivered.

                                  +

                                  Returns the number of messages in a queue ready to be delivered.

                                  see
                                  @@ -1021,17 +1438,20 @@
                                  resultHandler: function
                                    • -
                                    • (result: AsyncResult<any>): void
                                      • +
                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                    • Parameters

                                      • -
                                        result: AsyncResult<any>
                                        +
                                        res: AsyncResult<number>
                                      -

                                      Returns void

                                      +

                                      Returns void + | + Handler<AsyncResult<number>> +

                                    • @@ -1052,12 +1472,12 @@

                                    queueBind

                                  • -

                                    Bind a queue to an exchange

                                    +

                                    Bind a queue to an exchange

                                    see
                                    @@ -1081,17 +1501,20 @@
                                    resultHandler: function
                                      • -
                                      • (result: AsyncResult<void>): void
                                        • +
                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                      • Parameters

                                        • -
                                          result: AsyncResult<void>
                                          +
                                          res: AsyncResult<void>
                                        -

                                        Returns void

                                        +

                                        Returns void + | + Handler<AsyncResult<void>> +

                                      • @@ -1113,12 +1536,12 @@

                                      queueDeclare

                                    • -

                                      Declare a queue

                                      +

                                      Declare a queue

                                      see
                                      @@ -1145,17 +1568,20 @@
                                      resultHandler: function
                                        • -
                                        • (result: AsyncResult<any>): void
                                          • +
                                        • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                        • Parameters

                                          • -
                                            result: AsyncResult<any>
                                            +
                                            res: AsyncResult<object>
                                          -

                                          Returns void

                                          +

                                          Returns void + | + Handler<AsyncResult<object>> +

                                        • @@ -1167,12 +1593,12 @@

                                        Returns void
                                        -

                                        Declare a queue with config options

                                        +

                                        Declare a queue with config options

                                        see
                                        @@ -1196,23 +1622,31 @@
                                        autoDelete: boolean
                                      • config: object
                                        +
                                          +
                                        • +
                                          [key: string]: any
                                          +
                                          • +
                                      • resultHandler: function
                                          • -
                                          • (result: AsyncResult<any>): void
                                            • +
                                          • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                          • Parameters

                                            • -
                                              result: AsyncResult<any>
                                              +
                                              res: AsyncResult<object>
                                            -

                                            Returns void

                                            +

                                            Returns void + | + Handler<AsyncResult<object>> +

                                          • @@ -1233,12 +1667,12 @@

                                          queueDeclareAuto

                                        • -

                                          Actively declare a server-named exclusive, autodelete, non-durable queue.

                                          +

                                          Actively declare a server-named exclusive, autodelete, non-durable queue.

                                          see
                                          @@ -1253,17 +1687,20 @@
                                          resultHandler: function
                                            • -
                                            • (result: AsyncResult<any>): void
                                              • +
                                            • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                            • Parameters

                                              • -
                                                result: AsyncResult<any>
                                                +
                                                res: AsyncResult<object>
                                              -

                                              Returns void

                                              +

                                              Returns void + | + Handler<AsyncResult<object>> +

                                            • @@ -1284,12 +1721,12 @@

                                            queueDelete

                                          • -

                                            Delete a queue, without regard for whether it is in use or has messages on it

                                            +

                                            Delete a queue, without regard for whether it is in use or has messages on it

                                            see
                                            @@ -1307,17 +1744,20 @@
                                            resultHandler: function
                                              • -
                                              • (result: AsyncResult<any>): void
                                                • +
                                              • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                              • Parameters

                                                • -
                                                  result: AsyncResult<any>
                                                  +
                                                  res: AsyncResult<object>
                                                -

                                                Returns void

                                                +

                                                Returns void + | + Handler<AsyncResult<object>> +

                                              • @@ -1338,12 +1778,12 @@

                                              queueDeleteIf

                                            • -

                                              Delete a queue

                                              +

                                              Delete a queue

                                              see
                                              @@ -1367,17 +1807,20 @@
                                              resultHandler: function
                                                • -
                                                • (result: AsyncResult<any>): void
                                                  • +
                                                • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                                • Parameters

                                                  • -
                                                    result: AsyncResult<any>
                                                    +
                                                    res: AsyncResult<object>
                                                  -

                                                  Returns void

                                                  +

                                                  Returns void + | + Handler<AsyncResult<object>> +

                                                • @@ -1398,12 +1841,12 @@

                                                start

                                              • -

                                                Start the rabbitMQ client. Create the connection and the chanel.

                                                +

                                                Start the rabbitMQ client. Create the connection and the chanel.

                                                see
                                                @@ -1418,17 +1861,20 @@
                                                resultHandler: function
                                                  • -
                                                  • (result: AsyncResult<void>): void
                                                    • +
                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                  • Parameters

                                                    • -
                                                      result: AsyncResult<void>
                                                      +
                                                      res: AsyncResult<void>
                                                    -

                                                    Returns void

                                                    +

                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                  • @@ -1449,12 +1895,12 @@

                                                  stop

                                                • -

                                                  Stop the rabbitMQ client. Close the connection and its chanel.

                                                  +

                                                  Stop the rabbitMQ client. Close the connection and its chanel.

                                                  see
                                                  @@ -1469,17 +1915,20 @@
                                                  resultHandler: function
                                                    • -
                                                    • (result: AsyncResult<void>): void
                                                      • +
                                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                    • Parameters

                                                      • -
                                                        result: AsyncResult<void>
                                                        +
                                                        res: AsyncResult<void>
                                                      -

                                                      Returns void

                                                      +

                                                      Returns void + | + Handler<AsyncResult<void>> +

                                                    • @@ -1501,12 +1950,12 @@

                                                    waitForConfirms

                                                  • -

                                                    Wait until all messages published since the last call have been either ack'd or nack'd by the broker. +

                                                    Wait until all messages published since the last call have been either ack'd or nack'd by the broker. This will incur slight performance loss at the expense of higher write consistency. If desired, multiple calls to basicPublish() can be batched before confirming.

                                                    @@ -1529,17 +1978,20 @@
                                                    resultHandler: function
                                                      • -
                                                      • (result: AsyncResult<void>): void
                                                        • +
                                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                      • Parameters

                                                        • -
                                                          result: AsyncResult<void>
                                                          +
                                                          res: AsyncResult<void>
                                                        -

                                                        Returns void

                                                        +

                                                        Returns void + | + Handler<AsyncResult<void>> +

                                                      • @@ -1551,12 +2003,12 @@

                                                      Returns void
                                                      -

                                                      Wait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses. If the timeout expires a TimeoutException is thrown.

                                                      +

                                                      Wait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses. If the timeout expires a TimeoutException is thrown.

                                                      see
                                                      @@ -1580,17 +2032,20 @@
                                                      resultHandler: function
                                                        • -
                                                        • (result: AsyncResult<void>): void
                                                          • +
                                                        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                        • Parameters

                                                          • -
                                                            result: AsyncResult<void>
                                                            +
                                                            res: AsyncResult<void>
                                                          -

                                                          Returns void

                                                          +

                                                          Returns void + | + Handler<AsyncResult<void>> +

                                                        • @@ -1605,18 +2060,42 @@

                                                        Returns void

                                                        Static create

                                                        • +
                                                          +
                                                          +

                                                          Create and return a client configured with the default options.

                                                          +
                                                          +
                                                          +

                                                          Parameters

                                                          +
                                                            +
                                                          • +
                                                            vertx: Vertx
                                                            +
                                                            +

                                                            the vertx instance

                                                            +
                                                            +
                                                            • +
                                                          +

                                                          Returns RabbitMQClient

                                                          +

                                                          the client

                                                          +
                                                          • +
                                                        • +
                                                          -

                                                          Create and return a client.

                                                          +

                                                          Create and return a client.

                                                          Parameters

                                                          @@ -1651,6 +2130,15 @@

                                                          Returns
                                                          • @@ -1659,9 +2147,15 @@

                                                            Returns basicAck

                                                            • +
                                                          • + basicCancel +
                                                          • basicConsume
                                                            • +
                                                          • + basicConsumer +
                                                          • basicGet
                                                            • @@ -1729,6 +2223,12 @@

                                                            Returns +
                                                          • + RabbitMQConsumer +
                                                            • +
                                                          • + RabbitMQMessage +
                                                          • RabbitMQOptions
                                                            • diff --git a/docs/@vertx/rabbitmq-client/classes/rabbitmqconsumer.html b/docs/@vertx/rabbitmq-client/classes/rabbitmqconsumer.html new file mode 100644 index 000000000..8bf6c838e --- /dev/null +++ b/docs/@vertx/rabbitmq-client/classes/rabbitmqconsumer.html @@ -0,0 +1,588 @@ + + + + + + RabbitMQConsumer | @vertx/rabbitmq-client + + + + + +
                                                            +
                                                            +
                                                            +
                                                            + +
                                                            +
                                                            + Options +
                                                            +
                                                            + All +
                                                              +
                                                            • Public
                                                              • +
                                                            • Public/Protected
                                                              • +
                                                            • All
                                                              • +
                                                            +
                                                            + + + + +
                                                            +
                                                            + Menu +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + +

                                                            Class RabbitMQConsumer

                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Hierarchy

                                                            +
                                                              +
                                                            • + RabbitMQConsumer +
                                                              • +
                                                            +
                                                            +
                                                            +

                                                            Implements

                                                            +
                                                              +
                                                            • any
                                                              • +
                                                            +
                                                            +
                                                            +

                                                            Index

                                                            +
                                                            +
                                                            +
                                                            +

                                                            Methods

                                                            + +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Methods

                                                            +
                                                            + +

                                                            cancel

                                                            +
                                                              +
                                                            • cancel(): void
                                                              • +
                                                            • cancel(cancelResult: function): void
                                                              • +
                                                            +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Stop message consumption from a queue. +

                                                              + The operation is asynchronous. When consumption will be stopped, you can by notified via {@link RabbitMQConsumer#endHandler(Handler)}

                                                              +
                                                              +
                                                              +

                                                              Returns void

                                                              +
                                                              • +
                                                            • + +
                                                              +
                                                              +

                                                              Stop message consumption from a queue. +

                                                              + The operation is asynchronous. When consumption will be stopped, you can by notified via {@link RabbitMQConsumer#endHandler(Handler)}

                                                              +
                                                              +
                                                              +

                                                              Parameters

                                                              +
                                                                +
                                                              • +
                                                                cancelResult: function
                                                                +
                                                                +

                                                                contains information about operation status: success/fail.

                                                                +
                                                                +
                                                                  +
                                                                • +
                                                                    +
                                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>
                                                                    • +
                                                                  +
                                                                    +
                                                                  • +

                                                                    Parameters

                                                                    +
                                                                      +
                                                                    • +
                                                                      res: AsyncResult<void>
                                                                      +
                                                                      • +
                                                                    +

                                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                                    +
                                                                    • +
                                                                  +
                                                                  • +
                                                                +
                                                                • +
                                                              +

                                                              Returns void

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            consumerTag

                                                            +
                                                              +
                                                            • consumerTag(): string
                                                              • +
                                                            +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Returns string

                                                              +

                                                              a consumer tag

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            endHandler

                                                            + +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Set an end handler. Once the stream has canceled successfully, the handler will be called.

                                                              +
                                                              +
                                                              +

                                                              Parameters

                                                              +
                                                                +
                                                              • +
                                                                endHandler: function
                                                                +
                                                                  +
                                                                • +
                                                                    +
                                                                  • (res: void): void | Handler<void> | null | undefined
                                                                    • +
                                                                  +
                                                                    +
                                                                  • +

                                                                    Parameters

                                                                    +
                                                                      +
                                                                    • +
                                                                      res: void
                                                                      +
                                                                      • +
                                                                    +

                                                                    Returns void + | + Handler<void> + | + null + | + undefined +

                                                                    +
                                                                    • +
                                                                  +
                                                                  • +
                                                                +
                                                                • +
                                                              +

                                                              Returns RabbitMQConsumer

                                                              +

                                                              a reference to this, so the API can be used fluently

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            exceptionHandler

                                                            + +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Set an exception handler on the read stream.

                                                              +
                                                              +
                                                              +

                                                              Parameters

                                                              +
                                                                +
                                                              • +
                                                                exceptionHandler: function
                                                                +
                                                                +

                                                                the exception handler

                                                                +
                                                                +
                                                                  +
                                                                • +
                                                                    +
                                                                  • (res: Error): void | Handler<Error> | null | undefined
                                                                    • +
                                                                  +
                                                                    +
                                                                  • +

                                                                    Parameters

                                                                    +
                                                                      +
                                                                    • +
                                                                      res: Error
                                                                      +
                                                                      • +
                                                                    +

                                                                    Returns void + | + Handler<Error> + | + null + | + undefined +

                                                                    +
                                                                    • +
                                                                  +
                                                                  • +
                                                                +
                                                                • +
                                                              +

                                                              Returns RabbitMQConsumer

                                                              +

                                                              a reference to this, so the API can be used fluently

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            fetch

                                                            + +
                                                              +
                                                            • + +

                                                              Parameters

                                                              +
                                                                +
                                                              • +
                                                                arg0: number
                                                                +
                                                                • +
                                                              +

                                                              Returns ReadStream<RabbitMQMessage>

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            handler

                                                            + +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Set a message handler. As message appear in a queue, the handler will be called with the message.

                                                              +
                                                              +
                                                              +

                                                              Parameters

                                                              + +

                                                              Returns RabbitMQConsumer

                                                              +

                                                              a reference to this, so the API can be used fluently

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            isPaused

                                                            +
                                                              +
                                                            • isPaused(): boolean
                                                              • +
                                                            +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Returns boolean

                                                              +

                                                              is the stream paused?

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            pause

                                                            + +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Pause the stream of incoming messages from queue. +

                                                              + The messages will continue to arrive, but they will be stored in a internal queue. + If the queue size would exceed the limit provided by {@link RabbitMQConsumer#size(int)}, then incoming messages will be discarded.

                                                              +
                                                              +
                                                              +

                                                              Returns RabbitMQConsumer

                                                              +

                                                              a reference to this, so the API can be used fluently

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            + +

                                                            resume

                                                            + +
                                                              +
                                                            • + +
                                                              +
                                                              +

                                                              Resume reading from a queue. Flushes internal queue.

                                                              +
                                                              +
                                                              +

                                                              Returns RabbitMQConsumer

                                                              +

                                                              a reference to this, so the API can be used fluently

                                                              +
                                                              • +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Legend

                                                            +
                                                            +
                                                              +
                                                            • Module
                                                              • +
                                                            • Object literal
                                                              • +
                                                            • Variable
                                                              • +
                                                            • Function
                                                              • +
                                                            • Function with type parameter
                                                              • +
                                                            • Index signature
                                                              • +
                                                            • Type alias
                                                              • +
                                                            +
                                                              +
                                                            • Enumeration
                                                              • +
                                                            • Enumeration member
                                                              • +
                                                            • Property
                                                              • +
                                                            • Method
                                                              • +
                                                            +
                                                              +
                                                            • Interface
                                                              • +
                                                            • Interface with type parameter
                                                              • +
                                                            • Constructor
                                                              • +
                                                            • Property
                                                              • +
                                                            • Method
                                                              • +
                                                            • Index signature
                                                              • +
                                                            +
                                                              +
                                                            • Class
                                                              • +
                                                            • Class with type parameter
                                                              • +
                                                            • Constructor
                                                              • +
                                                            • Property
                                                              • +
                                                            • Method
                                                              • +
                                                            • Accessor
                                                              • +
                                                            • Index signature
                                                              • +
                                                            +
                                                              +
                                                            • Inherited constructor
                                                              • +
                                                            • Inherited property
                                                              • +
                                                            • Inherited method
                                                              • +
                                                            • Inherited accessor
                                                              • +
                                                            +
                                                              +
                                                            • Protected property
                                                              • +
                                                            • Protected method
                                                              • +
                                                            • Protected accessor
                                                              • +
                                                            +
                                                              +
                                                            • Private property
                                                              • +
                                                            • Private method
                                                              • +
                                                            • Private accessor
                                                              • +
                                                            +
                                                              +
                                                            • Static property
                                                              • +
                                                            • Static method
                                                              • +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Generated using TypeDoc

                                                            +
                                                            +
                                                            + + + + \ No newline at end of file diff --git a/docs/@vertx/sql-common/classes/resultset.html b/docs/@vertx/rabbitmq-client/classes/rabbitmqmessage.html similarity index 59% rename from docs/@vertx/sql-common/classes/resultset.html rename to docs/@vertx/rabbitmq-client/classes/rabbitmqmessage.html index 29d67fe65..556045096 100644 --- a/docs/@vertx/sql-common/classes/resultset.html +++ b/docs/@vertx/rabbitmq-client/classes/rabbitmqmessage.html @@ -3,7 +3,7 @@ - ResultSet | @vertx/sql-common + RabbitMQMessage | @vertx/rabbitmq-client @@ -22,7 +22,7 @@
                                                          • Preparing search index...
                                                          • The search index is not available

                                                          - @vertx/sql-common + @vertx/rabbitmq-client

                                                      @@ -54,10 +54,10 @@ Globals
                                                    • - ResultSet + RabbitMQMessage

                                                    -

                                                    Class ResultSet

                                                    +

                                                    Class RabbitMQMessage

                                                  @@ -68,7 +68,7 @@

                                                  Class ResultSet

                                                  Hierarchy

                                                  • - ResultSet + RabbitMQMessage

    @@ -77,98 +77,98 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    columnNames

    -
    columnNames: string
    - -
    -
    -

    Get the column names

    -
    -
    -
    returns
    -

    the column names

    -
    -
    -
    +

    Methods

    +
    + +

    body

    +
      +
    • body(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Returns Buffer

      +

      the message body

      +
      • +
    -
    - -

    next

    -
    next: ResultSet
    - -
    -
    -

    Get the next result set

    -
    -
    -
    returns
    -

    the next resultset

    -
    -
    -
    +
    + +

    consumerTag

    +
      +
    • consumerTag(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the consumer tag associated with the consumer

      +
      • +
    -
    - -

    output

    -
    output: any[]
    - -
    -
    -

    Get the registered outputs

    -
    -
    -
    returns
    -

    the outputs

    -
    -
    -
    +
    + +

    envelope

    + +
      +
    • + +
      +
      +

      Returns Envelope

      +

      packaging data for the message

      +
      • +
    -
    - -

    results

    -
    results: any[]
    - -
    -
    -

    Get the results

    -
    -
    -
    returns
    -

    the results

    -
    -
    -
    +
    + +

    properties

    + +
      +
    • + +
      +
      +

      Returns BasicProperties

      +

      content header data for the message

      +
      • +
    @@ -182,56 +182,44 @@

    results

    diff --git a/docs/@vertx/rabbitmq-client/classes/rabbitmqoptions.html b/docs/@vertx/rabbitmq-client/classes/rabbitmqoptions.html index 2c96e72f5..8e5892c68 100644 --- a/docs/@vertx/rabbitmq-client/classes/rabbitmqoptions.html +++ b/docs/@vertx/rabbitmq-client/classes/rabbitmqoptions.html @@ -77,361 +77,895 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    automaticRecoveryEnabled

    -
    automaticRecoveryEnabled: boolean
    - -
    -
    -

    Enables or disables automatic connection recovery.

    -
    -
    -
    param
    -

    if {@code true}, enables connection recovery

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    connectionRetries

    -
    connectionRetries: number
    - -
    -
    -

    Set the number of connection retries to attempt when connecting, the {@code null} value disables it.

    -
    -
    -
    param
    -

    the number of retries

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getConnectionRetries

    +
      +
    • getConnectionRetries(): number
      • +
    +
      +
    • + +
      +
      +

      Set the number of connection retries to attempt when connecting, the {@code null} value disables it.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    connectionRetryDelay

    -
    connectionRetryDelay: number
    - -
    -
    -

    Set the delay in milliseconds between connection retries.

    -
    -
    -
    param
    -

    the delay in milliseconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getConnectionRetryDelay

    +
      +
    • getConnectionRetryDelay(): number
      • +
    +
      +
    • + +
      +
      +

      Set the delay in milliseconds between connection retries.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    connectionTimeout

    -
    connectionTimeout: number
    - -
    -
    -

    Set the TCP connection timeout, in milliseconds, {@code zero} for infinite).

    -
    -
    -
    param
    -

    the timeouut in milliseconds.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getConnectionTimeout

    +
      +
    • getConnectionTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the TCP connection timeout, in milliseconds, {@code zero} for infinite).

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    handshakeTimeout

    -
    handshakeTimeout: number
    - -
    -
    -

    Set the AMQP 0-9-1 protocol handshake timeout, in milliseconds

    -
    -
    -
    param
    -

    the timeout in milliseconds

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHandshakeTimeout

    +
      +
    • getHandshakeTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the AMQP 0-9-1 protocol handshake timeout, in milliseconds

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the default host to use for connections.

    -
    -
    -
    param
    -

    the default host

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the default host to use for connections.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    includeProperties

    -
    includeProperties: boolean
    - -
    -
    -

    Set wether to include properties when a broker message is passed on the event bus

    -
    -
    -
    param
    -

    wether to include properties

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIncludeProperties

    +
      +
    • getIncludeProperties(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set wether to include properties when a broker message is passed on the event bus

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    networkRecoveryInterval

    -
    networkRecoveryInterval: number
    - -
    -
    -

    Set how long in milliseconds will automatic recovery wait before attempting to reconnect, default is {@code 5000}

    -
    -
    -
    param
    -

    the connection recovery interval

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getNetworkRecoveryInterval

    +
      +
    • getNetworkRecoveryInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Set how long in milliseconds will automatic recovery wait before attempting to reconnect, default is {@code 5000}

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Set the password to use when connecting to the broker.

    -
    -
    -
    param
    -

    the password

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Set the password to use when connecting to the broker.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the default port to use for connections.

    -
    -
    -
    param
    -

    the default port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the default port to use for connections.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    requestedChannelMax

    -
    requestedChannelMax: number
    - -
    -
    -

    Set the initially requested maximum channel number, {@code zero} for unlimited.

    -
    -
    -
    param
    -

    the requested maximum channel number

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getRequestedChannelMax

    +
      +
    • getRequestedChannelMax(): number
      • +
    +
      +
    • + +
      +
      +

      Set the initially requested maximum channel number, {@code zero} for unlimited.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    requestedHeartbeat

    -
    requestedHeartbeat: number
    - -
    -
    -

    Set the initially requested heartbeat interval, in seconds, {@code zero} for none.

    -
    -
    -
    param
    -

    the request heartbeat interval

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getRequestedHeartbeat

    +
      +
    • getRequestedHeartbeat(): number
      • +
    +
      +
    • + +
      +
      +

      Set the initially requested heartbeat interval, in seconds, {@code zero} for none.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    uri

    -
    uri: string
    - +
    + +

    getUri

    +
      +
    • getUri(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    user

    -
    user: string
    - -
    -
    -

    Set the AMQP user name to use when connecting to the broker.

    -
    -
    -
    param
    -

    the user name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getUser

    +
      +
    • getUser(): string
      • +
    +
      +
    • + +
      +
      +

      Set the AMQP user name to use when connecting to the broker.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    virtualHost

    -
    virtualHost: string
    - -
    -
    -

    Set the virtual host to use when connecting to the broker.

    -
    -
    -
    param
    -

    the virtual host

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getVirtualHost

    +
      +
    • getVirtualHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the virtual host to use when connecting to the broker.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isAutomaticRecoveryEnabled

    +
      +
    • isAutomaticRecoveryEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enables or disables automatic connection recovery.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setAutomaticRecoveryEnabled

    +
      +
    • setAutomaticRecoveryEnabled(automaticRecoveryEnabled: boolean): RabbitMQOptions
      • +
    +
      +
    • + +
      +
      +

      Enables or disables automatic connection recovery.

      +
      +
      +

      Parameters

      +
        +
      • +
        automaticRecoveryEnabled: boolean
        +
        +

        if {@code true}, enables connection recovery

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConnectionRetries

    + +
      +
    • + +
      +
      +

      Set the number of connection retries to attempt when connecting, the {@code null} value disables it.

      +
      +
      +

      Parameters

      +
        +
      • +
        connectionRetries: number
        +
        +

        the number of retries

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConnectionRetryDelay

    +
      +
    • setConnectionRetryDelay(connectionRetryDelay: number): RabbitMQOptions
      • +
    +
      +
    • + +
      +
      +

      Set the delay in milliseconds between connection retries.

      +
      +
      +

      Parameters

      +
        +
      • +
        connectionRetryDelay: number
        +
        +

        the delay in milliseconds

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setConnectionTimeout

    + +
      +
    • + +
      +
      +

      Set the TCP connection timeout, in milliseconds, {@code zero} for infinite).

      +
      +
      +

      Parameters

      +
        +
      • +
        connectionTimeout: number
        +
        +

        the timeouut in milliseconds.

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHandshakeTimeout

    + +
      +
    • + +
      +
      +

      Set the AMQP 0-9-1 protocol handshake timeout, in milliseconds

      +
      +
      +

      Parameters

      +
        +
      • +
        handshakeTimeout: number
        +
        +

        the timeout in milliseconds

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set the default host to use for connections.

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the default host

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIncludeProperties

    + +
      +
    • + +
      +
      +

      Set wether to include properties when a broker message is passed on the event bus

      +
      +
      +

      Parameters

      +
        +
      • +
        includeProperties: boolean
        +
        +

        wether to include properties

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setNetworkRecoveryInterval

    +
      +
    • setNetworkRecoveryInterval(networkRecoveryInterval: number): RabbitMQOptions
      • +
    +
      +
    • + +
      +
      +

      Set how long in milliseconds will automatic recovery wait before attempting to reconnect, default is {@code 5000}

      +
      +
      +

      Parameters

      +
        +
      • +
        networkRecoveryInterval: number
        +
        +

        the connection recovery interval

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Set the password to use when connecting to the broker.

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        +

        the password

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the default port to use for connections.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the default port

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRequestedChannelMax

    + +
      +
    • + +
      +
      +

      Set the initially requested maximum channel number, {@code zero} for unlimited.

      +
      +
      +

      Parameters

      +
        +
      • +
        requestedChannelMax: number
        +
        +

        the requested maximum channel number

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setRequestedHeartbeat

    + +
      +
    • + +
      +
      +

      Set the initially requested heartbeat interval, in seconds, {@code zero} for none.

      +
      +
      +

      Parameters

      +
        +
      • +
        requestedHeartbeat: number
        +
        +

        the request heartbeat interval

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setUri

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        uri: string
        +
        • +
      +

      Returns RabbitMQOptions

      +
      • +
    +
    +
    + +

    setUser

    + +
      +
    • + +
      +
      +

      Set the AMQP user name to use when connecting to the broker.

      +
      +
      +

      Parameters

      +
        +
      • +
        user: string
        +
        +

        the user name

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setVirtualHost

    + +
      +
    • + +
      +
      +

      Set the virtual host to use when connecting to the broker.

      +
      +
      +

      Parameters

      +
        +
      • +
        virtualHost: string
        +
        +

        the virtual host

        +
        +
        • +
      +

      Returns RabbitMQOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -445,58 +979,121 @@

    virtualHost

    @@ -77,58 +77,139 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    ex

    -
    ex: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    nx

    -
    nx: boolean
    - +
    +
    +

    Methods

    +
    + +

    getOffset

    +
      +
    • getOffset(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    px

    -
    px: number
    - +
    + +

    getType

    +
      +
    • getType(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    xx

    -
    xx: boolean
    - +
    + +

    setOffset

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        offset: number
        +
        • +
      +

      Returns BitFieldGetCommand

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      +

      Returns BitFieldGetCommand

      +
      • +
    @@ -181,9 +262,30 @@

    xx

  • SlotCmd
    • -
  • + + + - - - @vertx/redis-client + @vertx/redis
    @@ -77,86 +77,217 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns GeoMember

      +
      • +
    • + +

      Parameters

      + +

      Returns GeoMember

      +
      • +
    +
    +
    +
    +

    Methods

    +

    latitude

    -
    latitude: number
    - -
    -
    -

    Set Latitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001

    -
    -
    -
    param
    -

    Valid latitudes are from -85.05112878 to 85.05112878 degrees.

    -
    -
    returns
    -

    self

    -
    -
    -
    +
      +
    • latitude(): number
      • +
    +
      +
    • + +
      +
      +

      Set Latitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001

      +
      +
      +

      Returns number

      +

      self

      +
      • +
    -
    +

    longitude

    -
    longitude: number
    - -
    -
    -

    Set Longitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001

    -
    -
    -
    param
    -

    Valid longitudes are from -180 to 180 degrees

    -
    -
    returns
    -

    self

    -
    -
    -
    +
      +
    • longitude(): number
      • +
    +
      +
    • + +
      +
      +

      Set Longitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001

      +
      +
      +

      Returns number

      +

      self

      +
      • +
    -
    +

    member

    -
    member: string
    - -
    -
    -

    Set the member name.

    -
    -
    -
    param
    -

    the name given

    -
    -
    returns
    -

    self

    -
    -
    -
    +
      +
    • member(): string
      • +
    +
      +
    • + +
      +
      +

      Set the member name.

      +
      +
      +

      Returns string

      +

      self

      +
      • +
    +
    +
    + +

    setLatitude

    +
      +
    • setLatitude(latitude: number): GeoMember
      • +
    +
      +
    • + +
      +
      +

      Set Latitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001

      +
      +
      +

      Parameters

      +
        +
      • +
        latitude: number
        +
        • +
      +

      Returns GeoMember

      +

      self

      +
      • +
    +
    +
    + +

    setLongitude

    +
      +
    • setLongitude(longitude: number): GeoMember
      • +
    +
      +
    • + +
      +
      +

      Set Longitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001

      +
      +
      +

      Parameters

      +
        +
      • +
        longitude: number
        +
        • +
      +

      Returns GeoMember

      +

      self

      +
      • +
    +
    +
    + +

    setMember

    + +
      +
    • + +
      +
      +

      Set the member name.

      +
      +
      +

      Parameters

      +
        +
      • +
        member: string
        +
        • +
      +

      Returns GeoMember

      +

      self

      +
      • +
    @@ -226,15 +357,27 @@

    member

  • GeoMember
    • diff --git a/docs/@vertx/redis/classes/georadiusoptions.html b/docs/@vertx/redis/classes/georadiusoptions.html new file mode 100644 index 000000000..6f53c63b6 --- /dev/null +++ b/docs/@vertx/redis/classes/georadiusoptions.html @@ -0,0 +1,555 @@ + + + + + + GeoRadiusOptions | @vertx/redis + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class GeoRadiusOptions

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + GeoRadiusOptions +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    count

    +
      +
    • count(): number
      • +
    +
      +
    • + +
      +
      +

      Set the radius options limit the result count.

      +
      +
      +

      Returns number

      +

      self

      +
      • +
    +
    +
    + +

    setCount

    + +
      +
    • + +
      +
      +

      Set the radius options limit the result count.

      +
      +
      +

      Parameters

      +
        +
      • +
        count: number
        +
        • +
      +

      Returns GeoRadiusOptions

      +

      self

      +
      • +
    +
    +
    + +

    setWithCoord

    + +
      +
    • + +
      +
      +

      Set the radius options to be coordinate based.

      +
      +
      +

      Parameters

      +
        +
      • +
        withCoord: boolean
        +
        • +
      +

      Returns GeoRadiusOptions

      +

      self

      +
      • +
    +
    +
    + +

    setWithDist

    + +
      +
    • + +
      +
      +

      Set the radius options to be distance based.

      +
      +
      +

      Parameters

      +
        +
      • +
        withDist: boolean
        +
        • +
      +

      Returns GeoRadiusOptions

      +

      self

      +
      • +
    +
    +
    + +

    setWithHash

    + +
      +
    • + +
      +
      +

      Set the radius options to be hash based.

      +
      +
      +

      Parameters

      +
        +
      • +
        withHash: boolean
        +
        • +
      +

      Returns GeoRadiusOptions

      +

      self

      +
      • +
    +
    +
    + +

    withCoord

    +
      +
    • withCoord(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the radius options to be coordinate based.

      +
      +
      +

      Returns boolean

      +

      self

      +
      • +
    +
    +
    + +

    withDist

    +
      +
    • withDist(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the radius options to be distance based.

      +
      +
      +

      Returns boolean

      +

      self

      +
      • +
    +
    +
    + +

    withHash

    +
      +
    • withHash(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the radius options to be hash based.

      +
      +
      +

      Returns boolean

      +

      self

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/redis/classes/killfilter.html b/docs/@vertx/redis/classes/killfilter.html new file mode 100644 index 000000000..67e07874b --- /dev/null +++ b/docs/@vertx/redis/classes/killfilter.html @@ -0,0 +1,561 @@ + + + + + + KillFilter | @vertx/redis + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class KillFilter

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + KillFilter +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns KillFilter

      +
      • +
    • + +

      Parameters

      + +

      Returns KillFilter

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addr

    +
      +
    • addr(): string
      • +
    +
      +
    • + +
      +
      +

      Set ADDR filter

      +
      +
      +

      Returns string

      +

      This

      +
      • +
    +
    +
    + +

    id

    +
      +
    • id(): string
      • +
    +
      +
    • + +
      +
      +

      Set ID filter

      +
      +
      +

      Returns string

      +

      This

      +
      • +
    +
    +
    + +

    setAddr

    + +
      +
    • + +
      +
      +

      Set ADDR filter

      +
      +
      +

      Parameters

      +
        +
      • +
        addr: string
        +
        +

        Address filter of form addr:port

        +
        +
        • +
      +

      Returns KillFilter

      +

      This

      +
      • +
    +
    +
    + +

    setId

    + +
      +
    • + +
      +
      +

      Set ID filter

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +
        • +
      +

      Returns KillFilter

      +

      This

      +
      • +
    +
    +
    + +

    setSkipme

    + +
      +
    • + +
      +
      +

      Set SKIPME filter

      +
      +
      +

      Parameters

      +
        +
      • +
        skipme: boolean
        +
        • +
      +

      Returns KillFilter

      +

      This

      +
      • +
    +
    +
    + +

    setType

    + +
      +
    • + +
      +
      +

      Set TYPE filter

      +
      +
      +

      Parameters

      +
        +
      • +
        type: Type
        +
        +

        KillType to include

        +
        +
        • +
      +

      Returns KillFilter

      +

      This

      +
      • +
    +
    +
    + +

    skipme

    +
      +
    • skipme(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set SKIPME filter

      +
      +
      +

      Returns boolean

      +

      This

      +
      • +
    +
    +
    + +

    type

    +
      +
    • type(): Type
      • +
    +
      +
    • + +
      +
      +

      Set TYPE filter

      +
      +
      +

      Returns Type

      +

      This

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/redis-client/classes/bitfieldincrbycommand.html b/docs/@vertx/redis/classes/limitoptions.html similarity index 61% rename from docs/@vertx/redis-client/classes/bitfieldincrbycommand.html rename to docs/@vertx/redis/classes/limitoptions.html index e4de1f3c5..edc6d09cf 100644 --- a/docs/@vertx/redis-client/classes/bitfieldincrbycommand.html +++ b/docs/@vertx/redis/classes/limitoptions.html @@ -3,7 +3,7 @@ - BitFieldIncrbyCommand | @vertx/redis-client + LimitOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -54,10 +54,10 @@ Globals
  • - BitFieldIncrbyCommand + LimitOptions
    • -

    Class BitFieldIncrbyCommand

    +

    Class LimitOptions

    @@ -68,7 +68,7 @@

    Class BitFieldIncrbyCommand

    Hierarchy

    • - BitFieldIncrbyCommand + LimitOptions
    @@ -77,47 +77,139 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    increment

    -
    increment: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    +
    +
    +

    Methods

    +
    + +

    count

    +
      +
    • count(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +

    offset

    -
    offset: number
    - +
      +
    • offset(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    type

    -
    type: string
    - +
    + +

    setCount

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        count: number
        +
        • +
      +

      Returns LimitOptions

      +
      • +
    +
    +
    + +

    setOffset

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        offset: number
        +
        • +
      +

      Returns LimitOptions

      +
      • +
    @@ -173,24 +265,9 @@

    type

  • BitFieldGetCommand
    • - - - + +
    • MigrateOptions
      • diff --git a/docs/@vertx/redis-client/classes/killfilter.html b/docs/@vertx/redis/classes/migrateoptions.html similarity index 61% rename from docs/@vertx/redis-client/classes/killfilter.html rename to docs/@vertx/redis/classes/migrateoptions.html index 26f1442d2..f3de7402c 100644 --- a/docs/@vertx/redis-client/classes/killfilter.html +++ b/docs/@vertx/redis/classes/migrateoptions.html @@ -3,7 +3,7 @@ - KillFilter | @vertx/redis-client + MigrateOptions | @vertx/redis @@ -22,7 +22,7 @@
    • Preparing search index...
    • The search index is not available
    - @vertx/redis-client + @vertx/redis
    @@ -54,10 +54,10 @@ Globals
  • - KillFilter + MigrateOptions
    • -

    Class KillFilter

    +

    Class MigrateOptions

    @@ -68,7 +68,7 @@

    Class KillFilter

    Hierarchy

    • - KillFilter + MigrateOptions
    @@ -77,110 +77,139 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    addr

    -
    addr: string
    - -
    -
    -

    Set ADDR filter

    -
    -
    -
    param
    -

    Address filter of form addr:port

    -
    -
    returns
    -

    This

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    id

    -
    id: string
    - -
    -
    -

    Set ID filter

    -
    -
    -
    param
    -

    Client id as returned by CLIENT LIST command

    -
    -
    returns
    -

    This

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    copy

    +
      +
    • copy(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    skipme

    -
    skipme: boolean
    - -
    -
    -

    Set SKIPME filter

    -
    -
    -
    param
    -

    True if current client should be excluded from KILL

    -
    -
    returns
    -

    This

    -
    -
    -
    +
    + +

    replace

    +
      +
    • replace(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    type

    -
    type: Type
    - -
    -
    -

    Set TYPE filter

    -
    -
    -
    param
    -

    KillType to include

    -
    -
    returns
    -

    This

    -
    -
    -
    +
    + +

    setCopy

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        copy: boolean
        +
        • +
      +

      Returns MigrateOptions

      +
      • +
    +
    +
    + +

    setReplace

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        replace: boolean
        +
        • +
      +

      Returns MigrateOptions

      +
      • +
    @@ -251,33 +280,36 @@

    type

  • GeoRadiusOptions
    • +
  • + KillFilter +
    • +
  • + LimitOptions +
      • -
    • - LimitOptions -
      • -
    • - MigrateOptions -
    • RangeLimitOptions
      • diff --git a/docs/@vertx/redis/classes/rangelimitoptions.html b/docs/@vertx/redis/classes/rangelimitoptions.html new file mode 100644 index 000000000..bd21ddfab --- /dev/null +++ b/docs/@vertx/redis/classes/rangelimitoptions.html @@ -0,0 +1,459 @@ + + + + + + RangeLimitOptions | @vertx/redis + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
        • +
      • Public/Protected
        • +
      • All
        • +
      +
      + + + + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Class RangeLimitOptions

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • + RangeLimitOptions +
        • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Constructors

      + +
      +
      +

      Methods

      + +
      +
      +
      +
      +
      +

      Constructors

      +
      + +

      constructor

      + + +
      +
      +
      +

      Methods

      +
      + +

      count

      +
        +
      • count(): number
        • +
      +
        +
      • + +

        Returns number

        +
        • +
      +
      +
      + +

      offset

      +
        +
      • offset(): number
        • +
      +
        +
      • + +

        Returns number

        +
        • +
      +
      +
      + +

      setCount

      + +
        +
      • + +

        Parameters

        +
          +
        • +
          count: number
          +
          • +
        +

        Returns RangeLimitOptions

        +
        • +
      +
      +
      + +

      setOffset

      + +
        +
      • + +

        Parameters

        +
          +
        • +
          offset: number
          +
          • +
        +

        Returns RangeLimitOptions

        +
        • +
      +
      +
      + +

      setWithscores

      + +
        +
      • + +

        Parameters

        +
          +
        • +
          withscores: boolean
          +
          • +
        +

        Returns RangeLimitOptions

        +
        • +
      +
      +
      + +

      withscores

      +
        +
      • withscores(): boolean
        • +
      +
        +
      • + +

        Returns boolean

        +
        • +
      +
      +
      +
      +
      + + +
      +
      +
      +
      +
      +

      Legend

      +
      +
        +
      • Module
        • +
      • Object literal
        • +
      • Variable
        • +
      • Function
        • +
      • Function with type parameter
        • +
      • Index signature
        • +
      • Type alias
        • +
      +
        +
      • Enumeration
        • +
      • Enumeration member
        • +
      • Property
        • +
      • Method
        • +
      +
        +
      • Interface
        • +
      • Interface with type parameter
        • +
      • Constructor
        • +
      • Property
        • +
      • Method
        • +
      • Index signature
        • +
      +
        +
      • Class
        • +
      • Class with type parameter
        • +
      • Constructor
        • +
      • Property
        • +
      • Method
        • +
      • Accessor
        • +
      • Index signature
        • +
      +
        +
      • Inherited constructor
        • +
      • Inherited property
        • +
      • Inherited method
        • +
      • Inherited accessor
        • +
      +
        +
      • Protected property
        • +
      • Protected method
        • +
      • Protected accessor
        • +
      +
        +
      • Private property
        • +
      • Private method
        • +
      • Private accessor
        • +
      +
        +
      • Static property
        • +
      • Static method
        • +
      +
      +
      +
      +
      +

      Generated using TypeDoc

      +
      +
      + + + + \ No newline at end of file diff --git a/docs/@vertx/redis-client/classes/redisclient.html b/docs/@vertx/redis/classes/redisclient.html similarity index 64% rename from docs/@vertx/redis-client/classes/redisclient.html rename to docs/@vertx/redis/classes/redisclient.html index 497a173f4..a0c57a223 100644 --- a/docs/@vertx/redis-client/classes/redisclient.html +++ b/docs/@vertx/redis/classes/redisclient.html @@ -3,7 +3,7 @@ - RedisClient | @vertx/redis-client + RedisClient | @vertx/redis @@ -22,7 +22,7 @@
    • Preparing search index...
    • The search index is not available
    - @vertx/redis-client + @vertx/redis
    @@ -339,12 +339,12 @@

    append

  • -

    Append a value to a key

    +

    Append a value to a key

    since
    @@ -375,17 +375,20 @@
    handler: function
      • -
      • (result: AsyncResult<number>): void
        • +
      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

      • Parameters

        • -
          result: AsyncResult<number>
          +
          res: AsyncResult<number>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<number>> +

      • @@ -406,12 +409,12 @@

      auth

    • -

      Authenticate to the server

      +

      Authenticate to the server

      since
      @@ -436,17 +439,20 @@
      handler: function
        • -
        • (result: AsyncResult<string>): void
          • +
        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

        • Parameters

          • -
            result: AsyncResult<string>
            +
            res: AsyncResult<string>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<string>> +

        • @@ -467,12 +473,12 @@

        bgrewriteaof

      • -

        Asynchronously rewrite the append-only file

        +

        Asynchronously rewrite the append-only file

        since
        @@ -488,17 +494,20 @@
        handler: function
          • -
          • (result: AsyncResult<string>): void
            • +
          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

          • Parameters

            • -
              result: AsyncResult<string>
              +
              res: AsyncResult<string>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<string>> +

          • @@ -519,12 +528,12 @@

          bgsave

        • -

          Asynchronously save the dataset to disk

          +

          Asynchronously save the dataset to disk

          since
          @@ -540,17 +549,20 @@
          handler: function
            • -
            • (result: AsyncResult<string>): void
              • +
            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

            • Parameters

              • -
                result: AsyncResult<string>
                +
                res: AsyncResult<string>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<string>> +

            • @@ -571,12 +583,12 @@

            bitcount

          • -

            Count set bits in a string

            +

            Count set bits in a string

            since
            @@ -601,17 +613,20 @@
            handler: function
              • -
              • (result: AsyncResult<number>): void
                • +
              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

              • Parameters

                • -
                  result: AsyncResult<number>
                  +
                  res: AsyncResult<number>
                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<number>> +

              • @@ -632,12 +647,12 @@

              bitcountRange

            • -

              Count set bits in a string

              +

              Count set bits in a string

              since
              @@ -674,17 +689,20 @@
              handler: function
                • -
                • (result: AsyncResult<number>): void
                  • +
                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                • Parameters

                  • -
                    result: AsyncResult<number>
                    +
                    res: AsyncResult<number>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<number>> +

                • @@ -705,12 +723,12 @@

                bitfield

              • -

                Perform arbitrary bitfield integer operations on strings.

                +

                Perform arbitrary bitfield integer operations on strings.

                since
                @@ -735,17 +753,20 @@
                handler: function
                  • -
                  • (result: AsyncResult<any[]>): void
                    • +
                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                  • Parameters

                    • -
                      result: AsyncResult<any[]>
                      +
                      res: AsyncResult<any[]>
                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<any[]>> +

                  • @@ -766,12 +787,12 @@

                  bitfieldWithOverflow

                • -

                  Perform arbitrary bitfield integer operations on strings.

                  +

                  Perform arbitrary bitfield integer operations on strings.

                  since
                  @@ -799,17 +820,20 @@
                  handler: function
                    • -
                    • (result: AsyncResult<any[]>): void
                      • +
                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                    • Parameters

                      • -
                        result: AsyncResult<any[]>
                        +
                        res: AsyncResult<any[]>
                      -

                      Returns void

                      +

                      Returns void + | + Handler<AsyncResult<any[]>> +

                    • @@ -830,12 +854,12 @@

                    bitop

                  • -

                    Perform bitwise operations between strings

                    +

                    Perform bitwise operations between strings

                    since
                    @@ -872,17 +896,20 @@
                    handler: function
                      • -
                      • (result: AsyncResult<number>): void
                        • +
                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                      • Parameters

                        • -
                          result: AsyncResult<number>
                          +
                          res: AsyncResult<number>
                        -

                        Returns void

                        +

                        Returns void + | + Handler<AsyncResult<number>> +

                      • @@ -903,12 +930,12 @@

                      bitpos

                    • -

                      Find first bit set or clear in a string

                      +

                      Find first bit set or clear in a string

                      since
                      @@ -939,17 +966,20 @@
                      handler: function
                        • -
                        • (result: AsyncResult<number>): void
                          • +
                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                        • Parameters

                          • -
                            result: AsyncResult<number>
                            +
                            res: AsyncResult<number>
                          -

                          Returns void

                          +

                          Returns void + | + Handler<AsyncResult<number>> +

                        • @@ -970,12 +1000,12 @@

                        bitposFrom

                      • -

                        Find first bit set or clear in a string

                        +

                        Find first bit set or clear in a string

                        See also bitposRange() method, which takes start, and stop offset.

                        @@ -1013,17 +1043,20 @@
                        handler: function
                          • -
                          • (result: AsyncResult<number>): void
                            • +
                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                          • Parameters

                            • -
                              result: AsyncResult<number>
                              +
                              res: AsyncResult<number>
                            -

                            Returns void

                            +

                            Returns void + | + Handler<AsyncResult<number>> +

                          • @@ -1044,12 +1077,12 @@

                          bitposRange

                        • -

                          Find first bit set or clear in a string

                          +

                          Find first bit set or clear in a string

                          Note: when both start, and stop offsets are specified, behaviour is slightly different than if only start is specified

                          @@ -1094,17 +1127,20 @@
                          handler: function
                            • -
                            • (result: AsyncResult<number>): void
                              • +
                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                            • Parameters

                              • -
                                result: AsyncResult<number>
                                +
                                res: AsyncResult<number>
                              -

                              Returns void

                              +

                              Returns void + | + Handler<AsyncResult<number>> +

                            • @@ -1125,12 +1161,12 @@

                            blpop

                          • -

                            Remove and get the first element in a list, or block until one is available

                            +

                            Remove and get the first element in a list, or block until one is available

                            since
                            @@ -1161,17 +1197,20 @@
                            handler: function
                              • -
                              • (result: AsyncResult<any[]>): void
                                • +
                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                              • Parameters

                                • -
                                  result: AsyncResult<any[]>
                                  +
                                  res: AsyncResult<any[]>
                                -

                                Returns void

                                +

                                Returns void + | + Handler<AsyncResult<any[]>> +

                              • @@ -1192,12 +1231,12 @@

                              blpopMany

                            • -

                              Remove and get the first element in any of the lists, or block until one is available

                              +

                              Remove and get the first element in any of the lists, or block until one is available

                              since
                              @@ -1228,17 +1267,20 @@
                              handler: function
                                • -
                                • (result: AsyncResult<any[]>): void
                                  • +
                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                • Parameters

                                  • -
                                    result: AsyncResult<any[]>
                                    +
                                    res: AsyncResult<any[]>
                                  -

                                  Returns void

                                  +

                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                • @@ -1259,12 +1301,12 @@

                                brpop

                              • -

                                Remove and get the last element in a list, or block until one is available

                                +

                                Remove and get the last element in a list, or block until one is available

                                since
                                @@ -1295,17 +1337,20 @@
                                handler: function
                                  • -
                                  • (result: AsyncResult<any[]>): void
                                    • +
                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                  • Parameters

                                    • -
                                      result: AsyncResult<any[]>
                                      +
                                      res: AsyncResult<any[]>
                                    -

                                    Returns void

                                    +

                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                  • @@ -1326,12 +1371,12 @@

                                  brpopMany

                                • -

                                  Remove and get the last element in any of the lists, or block until one is available

                                  +

                                  Remove and get the last element in any of the lists, or block until one is available

                                  since
                                  @@ -1362,17 +1407,20 @@
                                  handler: function
                                    • -
                                    • (result: AsyncResult<any[]>): void
                                      • +
                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                    • Parameters

                                      • -
                                        result: AsyncResult<any[]>
                                        +
                                        res: AsyncResult<any[]>
                                      -

                                      Returns void

                                      +

                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                    • @@ -1393,12 +1441,12 @@

                                    brpoplpush

                                  • -

                                    Pop a value from a list, push it to another list and return it; or block until one is available

                                    +

                                    Pop a value from a list, push it to another list and return it; or block until one is available

                                    since
                                    @@ -1435,17 +1483,20 @@
                                    handler: function
                                      • -
                                      • (result: AsyncResult<string>): void
                                        • +
                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                      • Parameters

                                        • -
                                          result: AsyncResult<string>
                                          +
                                          res: AsyncResult<string>
                                        -

                                        Returns void

                                        +

                                        Returns void + | + Handler<AsyncResult<string>> +

                                      • @@ -1466,12 +1517,12 @@

                                      clientGetname

                                    • -

                                      Get the current connection name

                                      +

                                      Get the current connection name

                                      since
                                      @@ -1487,17 +1538,20 @@
                                      handler: function
                                        • -
                                        • (result: AsyncResult<string>): void
                                          • +
                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                        • Parameters

                                          • -
                                            result: AsyncResult<string>
                                            +
                                            res: AsyncResult<string>
                                          -

                                          Returns void

                                          +

                                          Returns void + | + Handler<AsyncResult<string>> +

                                        • @@ -1518,12 +1572,12 @@

                                        clientKill

                                      • -

                                        Kill the connection of a client

                                        +

                                        Kill the connection of a client

                                        since
                                        @@ -1548,17 +1602,20 @@
                                        handler: function
                                          • -
                                          • (result: AsyncResult<number>): void
                                            • +
                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                          • Parameters

                                            • -
                                              result: AsyncResult<number>
                                              +
                                              res: AsyncResult<number>
                                            -

                                            Returns void

                                            +

                                            Returns void + | + Handler<AsyncResult<number>> +

                                          • @@ -1579,12 +1636,12 @@

                                          clientList

                                        • -

                                          Get the list of client connections

                                          +

                                          Get the list of client connections

                                          since
                                          @@ -1600,17 +1657,20 @@
                                          handler: function
                                            • -
                                            • (result: AsyncResult<string>): void
                                              • +
                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                            • Parameters

                                              • -
                                                result: AsyncResult<string>
                                                +
                                                res: AsyncResult<string>
                                              -

                                              Returns void

                                              +

                                              Returns void + | + Handler<AsyncResult<string>> +

                                            • @@ -1631,12 +1691,12 @@

                                            clientPause

                                          • -

                                            Stop processing commands from clients for some time

                                            +

                                            Stop processing commands from clients for some time

                                            since
                                            @@ -1661,17 +1721,20 @@
                                            handler: function
                                              • -
                                              • (result: AsyncResult<string>): void
                                                • +
                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                              • Parameters

                                                • -
                                                  result: AsyncResult<string>
                                                  +
                                                  res: AsyncResult<string>
                                                -

                                                Returns void

                                                +

                                                Returns void + | + Handler<AsyncResult<string>> +

                                              • @@ -1692,12 +1755,12 @@

                                              clientReply

                                            • -

                                              Instruct the server whether to reply to commands.

                                              +

                                              Instruct the server whether to reply to commands.

                                              since
                                              @@ -1716,17 +1779,20 @@
                                              handler: function
                                                • -
                                                • (result: AsyncResult<string>): void
                                                  • +
                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                • Parameters

                                                  • -
                                                    result: AsyncResult<string>
                                                    +
                                                    res: AsyncResult<string>
                                                  -

                                                  Returns void

                                                  +

                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                • @@ -1747,12 +1813,12 @@

                                                clientSetname

                                              • -

                                                Set the current connection name

                                                +

                                                Set the current connection name

                                                since
                                                @@ -1777,17 +1843,20 @@
                                                handler: function
                                                  • -
                                                  • (result: AsyncResult<string>): void
                                                    • +
                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                  • Parameters

                                                    • -
                                                      result: AsyncResult<string>
                                                      +
                                                      res: AsyncResult<string>
                                                    -

                                                    Returns void

                                                    +

                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                  • @@ -1808,12 +1877,12 @@

                                                  close

                                                • -

                                                  Close the client - when it is fully closed the handler will be called.

                                                  +

                                                  Close the client - when it is fully closed the handler will be called.

                                                  Parameters

                                                  @@ -1825,17 +1894,20 @@
                                                  handler: function
                                                    • -
                                                    • (result: AsyncResult<void>): void
                                                      • +
                                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                    • Parameters

                                                      • -
                                                        result: AsyncResult<void>
                                                        +
                                                        res: AsyncResult<void>
                                                      -

                                                      Returns void

                                                      +

                                                      Returns void + | + Handler<AsyncResult<void>> +

                                                    • @@ -1856,12 +1928,12 @@

                                                    clusterAddslots

                                                  • -

                                                    Assign new hash slots to receiving node.

                                                    +

                                                    Assign new hash slots to receiving node.

                                                    since
                                                    @@ -1883,17 +1955,20 @@
                                                    handler: function
                                                      • -
                                                      • (result: AsyncResult<void>): void
                                                        • +
                                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                      • Parameters

                                                        • -
                                                          result: AsyncResult<void>
                                                          +
                                                          res: AsyncResult<void>
                                                        -

                                                        Returns void

                                                        +

                                                        Returns void + | + Handler<AsyncResult<void>> +

                                                      • @@ -1914,12 +1989,12 @@

                                                      clusterCountFailureReports

                                                    • -

                                                      Return the number of failure reports active for a given node.

                                                      +

                                                      Return the number of failure reports active for a given node.

                                                      since
                                                      @@ -1941,17 +2016,20 @@
                                                      handler: function
                                                        • -
                                                        • (result: AsyncResult<number>): void
                                                          • +
                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                        • Parameters

                                                          • -
                                                            result: AsyncResult<number>
                                                            +
                                                            res: AsyncResult<number>
                                                          -

                                                          Returns void

                                                          +

                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                        • @@ -1972,12 +2050,12 @@

                                                        clusterCountkeysinslot

                                                      • -

                                                        Return the number of local keys in the specified hash slot.

                                                        +

                                                        Return the number of local keys in the specified hash slot.

                                                        since
                                                        @@ -1999,17 +2077,20 @@
                                                        handler: function
                                                          • -
                                                          • (result: AsyncResult<number>): void
                                                            • +
                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                          • Parameters

                                                            • -
                                                              result: AsyncResult<number>
                                                              +
                                                              res: AsyncResult<number>
                                                            -

                                                            Returns void

                                                            +

                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                          • @@ -2030,12 +2111,12 @@

                                                          clusterDelslots

                                                        • -

                                                          Set hash slots as unbound in receiving node.

                                                          +

                                                          Set hash slots as unbound in receiving node.

                                                          since
                                                          @@ -2057,17 +2138,20 @@
                                                          handler: function
                                                            • -
                                                            • (result: AsyncResult<void>): void
                                                              • +
                                                            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                            • Parameters

                                                              • -
                                                                result: AsyncResult<void>
                                                                +
                                                                res: AsyncResult<void>
                                                              -

                                                              Returns void

                                                              +

                                                              Returns void + | + Handler<AsyncResult<void>> +

                                                            • @@ -2088,12 +2172,12 @@

                                                            clusterDelslotsMany

                                                          • -

                                                            Set hash slots as unbound in receiving node.

                                                            +

                                                            Set hash slots as unbound in receiving node.

                                                            since
                                                            @@ -2115,17 +2199,20 @@
                                                            handler: function
                                                              • -
                                                              • (result: AsyncResult<void>): void
                                                                • +
                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                              • Parameters

                                                                • -
                                                                  result: AsyncResult<void>
                                                                  +
                                                                  res: AsyncResult<void>
                                                                -

                                                                Returns void

                                                                +

                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                              • @@ -2146,12 +2233,12 @@

                                                              clusterFailOverWithOptions

                                                            • -

                                                              Forces a slave to perform a manual failover of its master.

                                                              +

                                                              Forces a slave to perform a manual failover of its master.

                                                              since
                                                              @@ -2173,17 +2260,20 @@
                                                              handler: function
                                                                • -
                                                                • (result: AsyncResult<void>): void
                                                                  • +
                                                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                • Parameters

                                                                  • -
                                                                    result: AsyncResult<void>
                                                                    +
                                                                    res: AsyncResult<void>
                                                                  -

                                                                  Returns void

                                                                  +

                                                                  Returns void + | + Handler<AsyncResult<void>> +

                                                                • @@ -2204,12 +2294,12 @@

                                                                clusterFailover

                                                              • -

                                                                Forces a slave to perform a manual failover of its master.

                                                                +

                                                                Forces a slave to perform a manual failover of its master.

                                                                since
                                                                @@ -2228,17 +2318,20 @@
                                                                handler: function
                                                                  • -
                                                                  • (result: AsyncResult<void>): void
                                                                    • +
                                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                  • Parameters

                                                                    • -
                                                                      result: AsyncResult<void>
                                                                      +
                                                                      res: AsyncResult<void>
                                                                    -

                                                                    Returns void

                                                                    +

                                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                                  • @@ -2259,12 +2352,12 @@

                                                                  clusterForget

                                                                • -

                                                                  Remove a node from the nodes table.

                                                                  +

                                                                  Remove a node from the nodes table.

                                                                  since
                                                                  @@ -2286,17 +2379,20 @@
                                                                  handler: function
                                                                    • -
                                                                    • (result: AsyncResult<void>): void
                                                                      • +
                                                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                    • Parameters

                                                                      • -
                                                                        result: AsyncResult<void>
                                                                        +
                                                                        res: AsyncResult<void>
                                                                      -

                                                                      Returns void

                                                                      +

                                                                      Returns void + | + Handler<AsyncResult<void>> +

                                                                    • @@ -2317,12 +2413,12 @@

                                                                    clusterGetkeysinslot

                                                                  • -

                                                                    Return local key names in the specified hash slot.

                                                                    +

                                                                    Return local key names in the specified hash slot.

                                                                    since
                                                                    @@ -2347,17 +2443,20 @@
                                                                    handler: function
                                                                      • -
                                                                      • (result: AsyncResult<any[]>): void
                                                                        • +
                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                      • Parameters

                                                                        • -
                                                                          result: AsyncResult<any[]>
                                                                          +
                                                                          res: AsyncResult<any[]>
                                                                        -

                                                                        Returns void

                                                                        +

                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                      • @@ -2378,12 +2477,12 @@

                                                                      clusterInfo

                                                                    • -

                                                                      Provides info about Redis Cluster node state.

                                                                      +

                                                                      Provides info about Redis Cluster node state.

                                                                      since
                                                                      @@ -2402,17 +2501,20 @@
                                                                      handler: function
                                                                        • -
                                                                        • (result: AsyncResult<any[]>): void
                                                                          • +
                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                        • Parameters

                                                                          • -
                                                                            result: AsyncResult<any[]>
                                                                            +
                                                                            res: AsyncResult<any[]>
                                                                          -

                                                                          Returns void

                                                                          +

                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                        • @@ -2433,12 +2535,12 @@

                                                                        clusterKeyslot

                                                                      • -

                                                                        Returns the hash slot of the specified key.

                                                                        +

                                                                        Returns the hash slot of the specified key.

                                                                        since
                                                                        @@ -2460,17 +2562,20 @@
                                                                        handler: function
                                                                          • -
                                                                          • (result: AsyncResult<number>): void
                                                                            • +
                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                          • Parameters

                                                                            • -
                                                                              result: AsyncResult<number>
                                                                              +
                                                                              res: AsyncResult<number>
                                                                            -

                                                                            Returns void

                                                                            +

                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                          • @@ -2491,12 +2596,12 @@

                                                                          clusterMeet

                                                                        • -

                                                                          Force a node cluster to handshake with another node.

                                                                          +

                                                                          Force a node cluster to handshake with another node.

                                                                          since
                                                                          @@ -2521,17 +2626,20 @@
                                                                          handler: function
                                                                            • -
                                                                            • (result: AsyncResult<void>): void
                                                                              • +
                                                                            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                            • Parameters

                                                                              • -
                                                                                result: AsyncResult<void>
                                                                                +
                                                                                res: AsyncResult<void>
                                                                              -

                                                                              Returns void

                                                                              +

                                                                              Returns void + | + Handler<AsyncResult<void>> +

                                                                            • @@ -2552,12 +2660,12 @@

                                                                            clusterNodes

                                                                          • -

                                                                            Get Cluster config for the node.

                                                                            +

                                                                            Get Cluster config for the node.

                                                                            since
                                                                            @@ -2576,17 +2684,20 @@
                                                                            handler: function
                                                                              • -
                                                                              • (result: AsyncResult<any[]>): void
                                                                                • +
                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                              • Parameters

                                                                                • -
                                                                                  result: AsyncResult<any[]>
                                                                                  +
                                                                                  res: AsyncResult<any[]>
                                                                                -

                                                                                Returns void

                                                                                +

                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                              • @@ -2607,12 +2718,12 @@

                                                                              clusterReplicate

                                                                            • -

                                                                              Reconfigure a node as a slave of the specified master node.

                                                                              +

                                                                              Reconfigure a node as a slave of the specified master node.

                                                                              since
                                                                              @@ -2634,17 +2745,20 @@
                                                                              handler: function
                                                                                • -
                                                                                • (result: AsyncResult<void>): void
                                                                                  • +
                                                                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                • Parameters

                                                                                  • -
                                                                                    result: AsyncResult<void>
                                                                                    +
                                                                                    res: AsyncResult<void>
                                                                                  -

                                                                                  Returns void

                                                                                  +

                                                                                  Returns void + | + Handler<AsyncResult<void>> +

                                                                                • @@ -2665,12 +2779,12 @@

                                                                                clusterReset

                                                                              • -

                                                                                Reset a Redis Cluster node.

                                                                                +

                                                                                Reset a Redis Cluster node.

                                                                                since
                                                                                @@ -2689,17 +2803,20 @@
                                                                                handler: function
                                                                                  • -
                                                                                  • (result: AsyncResult<void>): void
                                                                                    • +
                                                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                  • Parameters

                                                                                    • -
                                                                                      result: AsyncResult<void>
                                                                                      +
                                                                                      res: AsyncResult<void>
                                                                                    -

                                                                                    Returns void

                                                                                    +

                                                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                                                  • @@ -2720,12 +2837,12 @@

                                                                                  clusterResetWithOptions

                                                                                • -

                                                                                  Reset a Redis Cluster node.

                                                                                  +

                                                                                  Reset a Redis Cluster node.

                                                                                  since
                                                                                  @@ -2747,17 +2864,20 @@
                                                                                  handler: function
                                                                                    • -
                                                                                    • (result: AsyncResult<void>): void
                                                                                      • +
                                                                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                    • Parameters

                                                                                      • -
                                                                                        result: AsyncResult<void>
                                                                                        +
                                                                                        res: AsyncResult<void>
                                                                                      -

                                                                                      Returns void

                                                                                      +

                                                                                      Returns void + | + Handler<AsyncResult<void>> +

                                                                                    • @@ -2778,12 +2898,12 @@

                                                                                    clusterSaveconfig

                                                                                  • -

                                                                                    Forces the node to save cluster state on disk.

                                                                                    +

                                                                                    Forces the node to save cluster state on disk.

                                                                                    since
                                                                                    @@ -2802,17 +2922,20 @@
                                                                                    handler: function
                                                                                      • -
                                                                                      • (result: AsyncResult<void>): void
                                                                                        • +
                                                                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                      • Parameters

                                                                                        • -
                                                                                          result: AsyncResult<void>
                                                                                          +
                                                                                          res: AsyncResult<void>
                                                                                        -

                                                                                        Returns void

                                                                                        +

                                                                                        Returns void + | + Handler<AsyncResult<void>> +

                                                                                      • @@ -2833,12 +2956,12 @@

                                                                                      clusterSetConfigEpoch

                                                                                    • -

                                                                                      Set the configuration epoch in a new node.

                                                                                      +

                                                                                      Set the configuration epoch in a new node.

                                                                                      since
                                                                                      @@ -2860,17 +2983,20 @@
                                                                                      handler: function
                                                                                        • -
                                                                                        • (result: AsyncResult<void>): void
                                                                                          • +
                                                                                        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                        • Parameters

                                                                                          • -
                                                                                            result: AsyncResult<void>
                                                                                            +
                                                                                            res: AsyncResult<void>
                                                                                          -

                                                                                          Returns void

                                                                                          +

                                                                                          Returns void + | + Handler<AsyncResult<void>> +

                                                                                        • @@ -2891,12 +3017,12 @@

                                                                                        clusterSetslot

                                                                                      • -

                                                                                        Bind an hash slot to a specific node.

                                                                                        +

                                                                                        Bind an hash slot to a specific node.

                                                                                        since
                                                                                        @@ -2921,17 +3047,20 @@
                                                                                        handler: function
                                                                                          • -
                                                                                          • (result: AsyncResult<void>): void
                                                                                            • +
                                                                                          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                          • Parameters

                                                                                            • -
                                                                                              result: AsyncResult<void>
                                                                                              +
                                                                                              res: AsyncResult<void>
                                                                                            -

                                                                                            Returns void

                                                                                            +

                                                                                            Returns void + | + Handler<AsyncResult<void>> +

                                                                                          • @@ -2952,12 +3081,12 @@

                                                                                          clusterSetslotWithNode

                                                                                        • -

                                                                                          Bind an hash slot to a specific node.

                                                                                          +

                                                                                          Bind an hash slot to a specific node.

                                                                                          since
                                                                                          @@ -2985,17 +3114,20 @@
                                                                                          handler: function
                                                                                            • -
                                                                                            • (result: AsyncResult<void>): void
                                                                                              • +
                                                                                            • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                            • Parameters

                                                                                              • -
                                                                                                result: AsyncResult<void>
                                                                                                +
                                                                                                res: AsyncResult<void>
                                                                                              -

                                                                                              Returns void

                                                                                              +

                                                                                              Returns void + | + Handler<AsyncResult<void>> +

                                                                                            • @@ -3016,12 +3148,12 @@

                                                                                            clusterSlaves

                                                                                          • -

                                                                                            List slave nodes of the specified master node.

                                                                                            +

                                                                                            List slave nodes of the specified master node.

                                                                                            since
                                                                                            @@ -3043,17 +3175,20 @@
                                                                                            handler: function
                                                                                              • -
                                                                                              • (result: AsyncResult<any[]>): void
                                                                                                • +
                                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                              • Parameters

                                                                                                • -
                                                                                                  result: AsyncResult<any[]>
                                                                                                  +
                                                                                                  res: AsyncResult<any[]>
                                                                                                -

                                                                                                Returns void

                                                                                                +

                                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                              • @@ -3074,12 +3209,12 @@

                                                                                              clusterSlots

                                                                                            • -

                                                                                              Get array of Cluster slot to node mappings

                                                                                              +

                                                                                              Get array of Cluster slot to node mappings

                                                                                              since
                                                                                              @@ -3095,17 +3230,20 @@
                                                                                              handler: function
                                                                                                • -
                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                  • +
                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                • Parameters

                                                                                                  • -
                                                                                                    result: AsyncResult<any[]>
                                                                                                    +
                                                                                                    res: AsyncResult<any[]>
                                                                                                  -

                                                                                                  Returns void

                                                                                                  +

                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                • @@ -3126,12 +3264,12 @@

                                                                                                command

                                                                                              • -

                                                                                                Get array of Redis command details

                                                                                                +

                                                                                                Get array of Redis command details

                                                                                                since
                                                                                                @@ -3147,17 +3285,20 @@
                                                                                                handler: function
                                                                                                  • -
                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                    • +
                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                  • Parameters

                                                                                                    • -
                                                                                                      result: AsyncResult<any[]>
                                                                                                      +
                                                                                                      res: AsyncResult<any[]>
                                                                                                    -

                                                                                                    Returns void

                                                                                                    +

                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                  • @@ -3178,12 +3319,12 @@

                                                                                                  commandCount

                                                                                                • -

                                                                                                  Get total number of Redis commands

                                                                                                  +

                                                                                                  Get total number of Redis commands

                                                                                                  since
                                                                                                  @@ -3199,17 +3340,20 @@
                                                                                                  handler: function
                                                                                                    • -
                                                                                                    • (result: AsyncResult<number>): void
                                                                                                      • +
                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                    • Parameters

                                                                                                      • -
                                                                                                        result: AsyncResult<number>
                                                                                                        +
                                                                                                        res: AsyncResult<number>
                                                                                                      -

                                                                                                      Returns void

                                                                                                      +

                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                    • @@ -3230,12 +3374,12 @@

                                                                                                    commandGetkeys

                                                                                                  • -

                                                                                                    Extract keys given a full Redis command

                                                                                                    +

                                                                                                    Extract keys given a full Redis command

                                                                                                    since
                                                                                                    @@ -3251,17 +3395,20 @@
                                                                                                    handler: function
                                                                                                      • -
                                                                                                      • (result: AsyncResult<any[]>): void
                                                                                                        • +
                                                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                      • Parameters

                                                                                                        • -
                                                                                                          result: AsyncResult<any[]>
                                                                                                          +
                                                                                                          res: AsyncResult<any[]>
                                                                                                        -

                                                                                                        Returns void

                                                                                                        +

                                                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                      • @@ -3282,12 +3429,12 @@

                                                                                                      commandInfo

                                                                                                    • -

                                                                                                      Get array of specific Redis command details

                                                                                                      +

                                                                                                      Get array of specific Redis command details

                                                                                                      since
                                                                                                      @@ -3312,17 +3459,20 @@
                                                                                                      handler: function
                                                                                                        • -
                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                          • +
                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                        • Parameters

                                                                                                          • -
                                                                                                            result: AsyncResult<any[]>
                                                                                                            +
                                                                                                            res: AsyncResult<any[]>
                                                                                                          -

                                                                                                          Returns void

                                                                                                          +

                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                        • @@ -3343,12 +3493,12 @@

                                                                                                        configGet

                                                                                                      • -

                                                                                                        Get the value of a configuration parameter

                                                                                                        +

                                                                                                        Get the value of a configuration parameter

                                                                                                        since
                                                                                                        @@ -3373,17 +3523,20 @@
                                                                                                        handler: function
                                                                                                          • -
                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                            • +
                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                          • Parameters

                                                                                                            • -
                                                                                                              result: AsyncResult<any[]>
                                                                                                              +
                                                                                                              res: AsyncResult<any[]>
                                                                                                            -

                                                                                                            Returns void

                                                                                                            +

                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                          • @@ -3404,12 +3557,12 @@

                                                                                                          configResetstat

                                                                                                        • -

                                                                                                          Reset the stats returned by INFO

                                                                                                          +

                                                                                                          Reset the stats returned by INFO

                                                                                                          since
                                                                                                          @@ -3425,17 +3578,20 @@
                                                                                                          handler: function
                                                                                                            • -
                                                                                                            • (result: AsyncResult<string>): void
                                                                                                              • +
                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                            • Parameters

                                                                                                              • -
                                                                                                                result: AsyncResult<string>
                                                                                                                +
                                                                                                                res: AsyncResult<string>
                                                                                                              -

                                                                                                              Returns void

                                                                                                              +

                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                            • @@ -3456,12 +3612,12 @@

                                                                                                            configRewrite

                                                                                                          • -

                                                                                                            Rewrite the configuration file with the in memory configuration

                                                                                                            +

                                                                                                            Rewrite the configuration file with the in memory configuration

                                                                                                            since
                                                                                                            @@ -3477,17 +3633,20 @@
                                                                                                            handler: function
                                                                                                              • -
                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                • +
                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                              • Parameters

                                                                                                                • -
                                                                                                                  result: AsyncResult<string>
                                                                                                                  +
                                                                                                                  res: AsyncResult<string>
                                                                                                                -

                                                                                                                Returns void

                                                                                                                +

                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                              • @@ -3508,12 +3667,12 @@

                                                                                                              configSet

                                                                                                            • -

                                                                                                              Set a configuration parameter to the given value

                                                                                                              +

                                                                                                              Set a configuration parameter to the given value

                                                                                                              since
                                                                                                              @@ -3544,17 +3703,20 @@
                                                                                                              handler: function
                                                                                                                • -
                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                  • +
                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                • Parameters

                                                                                                                  • -
                                                                                                                    result: AsyncResult<string>
                                                                                                                    +
                                                                                                                    res: AsyncResult<string>
                                                                                                                  -

                                                                                                                  Returns void

                                                                                                                  +

                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                • @@ -3575,12 +3737,12 @@

                                                                                                                dbsize

                                                                                                              • -

                                                                                                                Return the number of keys in the selected database

                                                                                                                +

                                                                                                                Return the number of keys in the selected database

                                                                                                                since
                                                                                                                @@ -3596,17 +3758,20 @@
                                                                                                                handler: function
                                                                                                                  • -
                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                    • +
                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                  • Parameters

                                                                                                                    • -
                                                                                                                      result: AsyncResult<number>
                                                                                                                      +
                                                                                                                      res: AsyncResult<number>
                                                                                                                    -

                                                                                                                    Returns void

                                                                                                                    +

                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                  • @@ -3627,12 +3792,12 @@

                                                                                                                  debugObject

                                                                                                                • -

                                                                                                                  Get debugging information about a key

                                                                                                                  +

                                                                                                                  Get debugging information about a key

                                                                                                                  since
                                                                                                                  @@ -3657,17 +3822,20 @@
                                                                                                                  handler: function
                                                                                                                    • -
                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                      • +
                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                    • Parameters

                                                                                                                      • -
                                                                                                                        result: AsyncResult<string>
                                                                                                                        +
                                                                                                                        res: AsyncResult<string>
                                                                                                                      -

                                                                                                                      Returns void

                                                                                                                      +

                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                    • @@ -3688,12 +3856,12 @@

                                                                                                                    debugSegfault

                                                                                                                  • -

                                                                                                                    Make the server crash

                                                                                                                    +

                                                                                                                    Make the server crash

                                                                                                                    since
                                                                                                                    @@ -3709,17 +3877,20 @@
                                                                                                                    handler: function
                                                                                                                      • -
                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                        • +
                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                      • Parameters

                                                                                                                        • -
                                                                                                                          result: AsyncResult<string>
                                                                                                                          +
                                                                                                                          res: AsyncResult<string>
                                                                                                                        -

                                                                                                                        Returns void

                                                                                                                        +

                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                      • @@ -3740,12 +3911,12 @@

                                                                                                                      decr

                                                                                                                    • -

                                                                                                                      Decrement the integer value of a key by one

                                                                                                                      +

                                                                                                                      Decrement the integer value of a key by one

                                                                                                                      since
                                                                                                                      @@ -3770,17 +3941,20 @@
                                                                                                                      handler: function
                                                                                                                        • -
                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                          • +
                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                        • Parameters

                                                                                                                          • -
                                                                                                                            result: AsyncResult<number>
                                                                                                                            +
                                                                                                                            res: AsyncResult<number>
                                                                                                                          -

                                                                                                                          Returns void

                                                                                                                          +

                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                        • @@ -3801,12 +3975,12 @@

                                                                                                                        decrby

                                                                                                                      • -

                                                                                                                        Decrement the integer value of a key by the given number

                                                                                                                        +

                                                                                                                        Decrement the integer value of a key by the given number

                                                                                                                        since
                                                                                                                        @@ -3837,17 +4011,20 @@
                                                                                                                        handler: function
                                                                                                                          • -
                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                            • +
                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                          • Parameters

                                                                                                                            • -
                                                                                                                              result: AsyncResult<number>
                                                                                                                              +
                                                                                                                              res: AsyncResult<number>
                                                                                                                            -

                                                                                                                            Returns void

                                                                                                                            +

                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                          • @@ -3868,12 +4045,12 @@

                                                                                                                          del

                                                                                                                        • -

                                                                                                                          Delete a key

                                                                                                                          +

                                                                                                                          Delete a key

                                                                                                                          since
                                                                                                                          @@ -3898,17 +4075,20 @@
                                                                                                                          handler: function
                                                                                                                            • -
                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                              • +
                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                            • Parameters

                                                                                                                              • -
                                                                                                                                result: AsyncResult<number>
                                                                                                                                +
                                                                                                                                res: AsyncResult<number>
                                                                                                                              -

                                                                                                                              Returns void

                                                                                                                              +

                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                            • @@ -3929,12 +4109,12 @@

                                                                                                                            delMany

                                                                                                                          • -

                                                                                                                            Delete many keys

                                                                                                                            +

                                                                                                                            Delete many keys

                                                                                                                            since
                                                                                                                            @@ -3959,17 +4139,20 @@
                                                                                                                            handler: function
                                                                                                                              • -
                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                • +
                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                              • Parameters

                                                                                                                                • -
                                                                                                                                  result: AsyncResult<number>
                                                                                                                                  +
                                                                                                                                  res: AsyncResult<number>
                                                                                                                                -

                                                                                                                                Returns void

                                                                                                                                +

                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                              • @@ -3990,12 +4173,12 @@

                                                                                                                              dump

                                                                                                                            • -

                                                                                                                              Return a serialized version of the value stored at the specified key.

                                                                                                                              +

                                                                                                                              Return a serialized version of the value stored at the specified key.

                                                                                                                              since
                                                                                                                              @@ -4020,17 +4203,20 @@
                                                                                                                              handler: function
                                                                                                                                • -
                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                  • +
                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                • Parameters

                                                                                                                                  • -
                                                                                                                                    result: AsyncResult<string>
                                                                                                                                    +
                                                                                                                                    res: AsyncResult<string>
                                                                                                                                  -

                                                                                                                                  Returns void

                                                                                                                                  +

                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                • @@ -4051,12 +4237,12 @@

                                                                                                                                echo

                                                                                                                              • -

                                                                                                                                Echo the given string

                                                                                                                                +

                                                                                                                                Echo the given string

                                                                                                                                since
                                                                                                                                @@ -4081,17 +4267,20 @@
                                                                                                                                handler: function
                                                                                                                                  • -
                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                    • +
                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                  • Parameters

                                                                                                                                    • -
                                                                                                                                      result: AsyncResult<string>
                                                                                                                                      +
                                                                                                                                      res: AsyncResult<string>
                                                                                                                                    -

                                                                                                                                    Returns void

                                                                                                                                    +

                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                  • @@ -4112,12 +4301,12 @@

                                                                                                                                  eval

                                                                                                                                • -

                                                                                                                                  Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned +

                                                                                                                                  Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned for This reason and to ensure type safety the reply is always guaranteed to be a JsonArray.

                                                                                                                                  When a reply if for example a String the handler will be called with a JsonArray with a single element containing @@ -4157,17 +4346,20 @@

                                                                                                                                  handler: function
                                                                                                                                    • -
                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                      • +
                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                    • Parameters

                                                                                                                                      • -
                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                        +
                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                      -

                                                                                                                                      Returns void

                                                                                                                                      +

                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                    • @@ -4188,12 +4380,12 @@

                                                                                                                                    evalScript

                                                                                                                                  • -

                                                                                                                                    Execute a Lua script server side. This method is a high level wrapper around EVAL and EVALSHA +

                                                                                                                                    Execute a Lua script server side. This method is a high level wrapper around EVAL and EVALSHA using the latter if possible, falling back to EVAL if the script is not cached by the server yet. According to Redis documentation, executed scripts are guaranteed to be in the script cache of a given execution of a Redis instance forever, which means typically the overhead incurred by @@ -4235,17 +4427,20 @@

                                                                                                                                    handler: function
                                                                                                                                      • -
                                                                                                                                      • (result: AsyncResult<any[]>): void
                                                                                                                                        • +
                                                                                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                      • Parameters

                                                                                                                                        • -
                                                                                                                                          result: AsyncResult<any[]>
                                                                                                                                          +
                                                                                                                                          res: AsyncResult<any[]>
                                                                                                                                        -

                                                                                                                                        Returns void

                                                                                                                                        +

                                                                                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                      • @@ -4266,12 +4461,12 @@

                                                                                                                                      evalsha

                                                                                                                                    • -

                                                                                                                                      Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned +

                                                                                                                                      Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned for This reason and to ensure type safety the reply is always guaranteed to be a JsonArray.

                                                                                                                                      When a reply if for example a String the handler will be called with a JsonArray with a single element containing @@ -4311,17 +4506,20 @@

                                                                                                                                      handler: function
                                                                                                                                        • -
                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                          • +
                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                        • Parameters

                                                                                                                                          • -
                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                            +
                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                          -

                                                                                                                                          Returns void

                                                                                                                                          +

                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                        • @@ -4342,12 +4540,12 @@

                                                                                                                                        exists

                                                                                                                                      • -

                                                                                                                                        Determine if a key exists

                                                                                                                                        +

                                                                                                                                        Determine if a key exists

                                                                                                                                        since
                                                                                                                                        @@ -4372,17 +4570,20 @@
                                                                                                                                        handler: function
                                                                                                                                          • -
                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                            • +
                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                          • Parameters

                                                                                                                                            • -
                                                                                                                                              result: AsyncResult<number>
                                                                                                                                              +
                                                                                                                                              res: AsyncResult<number>
                                                                                                                                            -

                                                                                                                                            Returns void

                                                                                                                                            +

                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                          • @@ -4403,12 +4604,12 @@

                                                                                                                                          existsMany

                                                                                                                                        • -

                                                                                                                                          Determine if one or many keys exist

                                                                                                                                          +

                                                                                                                                          Determine if one or many keys exist

                                                                                                                                          since
                                                                                                                                          @@ -4433,17 +4634,20 @@
                                                                                                                                          handler: function
                                                                                                                                            • -
                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                              • +
                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                            • Parameters

                                                                                                                                              • -
                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                +
                                                                                                                                                res: AsyncResult<number>
                                                                                                                                              -

                                                                                                                                              Returns void

                                                                                                                                              +

                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                            • @@ -4464,12 +4668,12 @@

                                                                                                                                            expire

                                                                                                                                          • -

                                                                                                                                            Set a key's time to live in seconds

                                                                                                                                            +

                                                                                                                                            Set a key's time to live in seconds

                                                                                                                                            since
                                                                                                                                            @@ -4500,17 +4704,20 @@
                                                                                                                                            handler: function
                                                                                                                                              • -
                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                • +
                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                              • Parameters

                                                                                                                                                • -
                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                  +
                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                -

                                                                                                                                                Returns void

                                                                                                                                                +

                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                              • @@ -4531,12 +4738,12 @@

                                                                                                                                              expireat

                                                                                                                                            • -

                                                                                                                                              Set the expiration for a key as a UNIX timestamp

                                                                                                                                              +

                                                                                                                                              Set the expiration for a key as a UNIX timestamp

                                                                                                                                              since
                                                                                                                                              @@ -4567,17 +4774,20 @@
                                                                                                                                              handler: function
                                                                                                                                                • -
                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                  • +
                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                • Parameters

                                                                                                                                                  • -
                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                    +
                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                  -

                                                                                                                                                  Returns void

                                                                                                                                                  +

                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                • @@ -4598,12 +4808,12 @@

                                                                                                                                                flushall

                                                                                                                                              • -

                                                                                                                                                Remove all keys from all databases

                                                                                                                                                +

                                                                                                                                                Remove all keys from all databases

                                                                                                                                                since
                                                                                                                                                @@ -4619,17 +4829,20 @@
                                                                                                                                                handler: function
                                                                                                                                                  • -
                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                    • +
                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                  • Parameters

                                                                                                                                                    • -
                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                      +
                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                    -

                                                                                                                                                    Returns void

                                                                                                                                                    +

                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                  • @@ -4650,12 +4863,12 @@

                                                                                                                                                  flushdb

                                                                                                                                                • -

                                                                                                                                                  Remove all keys from the current database

                                                                                                                                                  +

                                                                                                                                                  Remove all keys from the current database

                                                                                                                                                  since
                                                                                                                                                  @@ -4671,17 +4884,20 @@
                                                                                                                                                  handler: function
                                                                                                                                                    • -
                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                      • +
                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                    • Parameters

                                                                                                                                                      • -
                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                        +
                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                      -

                                                                                                                                                      Returns void

                                                                                                                                                      +

                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                    • @@ -4702,12 +4918,12 @@

                                                                                                                                                    geoadd

                                                                                                                                                  • -

                                                                                                                                                    Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                    +

                                                                                                                                                    Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                    since
                                                                                                                                                    @@ -4750,17 +4966,20 @@
                                                                                                                                                    handler: function
                                                                                                                                                      • -
                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                        • +
                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                      • Parameters

                                                                                                                                                        • -
                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                          +
                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                        -

                                                                                                                                                        Returns void

                                                                                                                                                        +

                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                      • @@ -4781,12 +5000,12 @@

                                                                                                                                                      geoaddMany

                                                                                                                                                    • -

                                                                                                                                                      Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                      +

                                                                                                                                                      Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                      since
                                                                                                                                                      @@ -4817,17 +5036,20 @@
                                                                                                                                                      handler: function
                                                                                                                                                        • -
                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                          • +
                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                        • Parameters

                                                                                                                                                          • -
                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                            +
                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                          -

                                                                                                                                                          Returns void

                                                                                                                                                          +

                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                        • @@ -4848,12 +5070,12 @@

                                                                                                                                                        geodist

                                                                                                                                                      • -

                                                                                                                                                        Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                        +

                                                                                                                                                        Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                        since
                                                                                                                                                        @@ -4890,17 +5112,20 @@
                                                                                                                                                        handler: function
                                                                                                                                                          • -
                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                            • +
                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                          • Parameters

                                                                                                                                                            • -
                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                              +
                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                            -

                                                                                                                                                            Returns void

                                                                                                                                                            +

                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                          • @@ -4921,12 +5146,12 @@

                                                                                                                                                          geodistWithUnit

                                                                                                                                                        • -

                                                                                                                                                          Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                          +

                                                                                                                                                          Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                          since
                                                                                                                                                          @@ -4969,17 +5194,20 @@
                                                                                                                                                          handler: function
                                                                                                                                                            • -
                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                              • +
                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                            • Parameters

                                                                                                                                                              • -
                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                +
                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                              -

                                                                                                                                                              Returns void

                                                                                                                                                              +

                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                            • @@ -5000,12 +5228,12 @@

                                                                                                                                                            geohash

                                                                                                                                                          • -

                                                                                                                                                            Return valid Geohash strings representing the position of one or more elements in a sorted set value representing +

                                                                                                                                                            Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

                                                                                                                                                            @@ -5037,17 +5265,20 @@
                                                                                                                                                            handler: function
                                                                                                                                                              • -
                                                                                                                                                              • (result: AsyncResult<any[]>): void
                                                                                                                                                                • +
                                                                                                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                              • Parameters

                                                                                                                                                                • -
                                                                                                                                                                  result: AsyncResult<any[]>
                                                                                                                                                                  +
                                                                                                                                                                  res: AsyncResult<any[]>
                                                                                                                                                                -

                                                                                                                                                                Returns void

                                                                                                                                                                +

                                                                                                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                              • @@ -5068,12 +5299,12 @@

                                                                                                                                                              geohashMany

                                                                                                                                                            • -

                                                                                                                                                              Return valid Geohash strings representing the position of one or more elements in a sorted set value representing +

                                                                                                                                                              Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

                                                                                                                                                              @@ -5105,17 +5336,20 @@
                                                                                                                                                              handler: function
                                                                                                                                                                • -
                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                  • +
                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                • Parameters

                                                                                                                                                                  • -
                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                    +
                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                  -

                                                                                                                                                                  Returns void

                                                                                                                                                                  +

                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                • @@ -5136,12 +5370,12 @@

                                                                                                                                                                geopos

                                                                                                                                                              • -

                                                                                                                                                                Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the +

                                                                                                                                                                Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

                                                                                                                                                                @@ -5173,17 +5407,20 @@
                                                                                                                                                                handler: function
                                                                                                                                                                  • -
                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                    • +
                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                  • Parameters

                                                                                                                                                                    • -
                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                      +
                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                    -

                                                                                                                                                                    Returns void

                                                                                                                                                                    +

                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                  • @@ -5204,12 +5441,12 @@

                                                                                                                                                                  geoposMany

                                                                                                                                                                • -

                                                                                                                                                                  Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the +

                                                                                                                                                                  Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

                                                                                                                                                                  @@ -5241,17 +5478,20 @@
                                                                                                                                                                  handler: function
                                                                                                                                                                    • -
                                                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                                                      • +
                                                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                    • Parameters

                                                                                                                                                                      • -
                                                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                                                        +
                                                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                                                      -

                                                                                                                                                                      Returns void

                                                                                                                                                                      +

                                                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                    • @@ -5272,12 +5512,12 @@

                                                                                                                                                                    georadius

                                                                                                                                                                  • -

                                                                                                                                                                    Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders +

                                                                                                                                                                    Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

                                                                                                                                                                    @@ -5327,17 +5567,20 @@
                                                                                                                                                                    handler: function
                                                                                                                                                                      • -
                                                                                                                                                                      • (result: AsyncResult<any[]>): void
                                                                                                                                                                        • +
                                                                                                                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                      • Parameters

                                                                                                                                                                        • -
                                                                                                                                                                          result: AsyncResult<any[]>
                                                                                                                                                                          +
                                                                                                                                                                          res: AsyncResult<any[]>
                                                                                                                                                                        -

                                                                                                                                                                        Returns void

                                                                                                                                                                        +

                                                                                                                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                      • @@ -5358,12 +5601,12 @@

                                                                                                                                                                      georadiusWithOptions

                                                                                                                                                                    • -

                                                                                                                                                                      Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders +

                                                                                                                                                                      Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

                                                                                                                                                                      @@ -5419,17 +5662,20 @@
                                                                                                                                                                      handler: function
                                                                                                                                                                        • -
                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                          • +
                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                        • Parameters

                                                                                                                                                                          • -
                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                            +
                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                          -

                                                                                                                                                                          Returns void

                                                                                                                                                                          +

                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                        • @@ -5450,12 +5696,12 @@

                                                                                                                                                                        georadiusbymember

                                                                                                                                                                      • -

                                                                                                                                                                        This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area +

                                                                                                                                                                        This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

                                                                                                                                                                        @@ -5500,17 +5746,20 @@
                                                                                                                                                                        handler: function
                                                                                                                                                                          • -
                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                            • +
                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                          • Parameters

                                                                                                                                                                            • -
                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                              +
                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                            -

                                                                                                                                                                            Returns void

                                                                                                                                                                            +

                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                          • @@ -5531,12 +5780,12 @@

                                                                                                                                                                          georadiusbymemberWithOptions

                                                                                                                                                                        • -

                                                                                                                                                                          This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area +

                                                                                                                                                                          This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

                                                                                                                                                                          @@ -5587,17 +5836,20 @@
                                                                                                                                                                          handler: function
                                                                                                                                                                            • -
                                                                                                                                                                            • (result: AsyncResult<any[]>): void
                                                                                                                                                                              • +
                                                                                                                                                                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                            • Parameters

                                                                                                                                                                              • -
                                                                                                                                                                                result: AsyncResult<any[]>
                                                                                                                                                                                +
                                                                                                                                                                                res: AsyncResult<any[]>
                                                                                                                                                                              -

                                                                                                                                                                              Returns void

                                                                                                                                                                              +

                                                                                                                                                                              Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                            • @@ -5618,12 +5870,12 @@

                                                                                                                                                                            get

                                                                                                                                                                          • -

                                                                                                                                                                            Get the value of a key

                                                                                                                                                                            +

                                                                                                                                                                            Get the value of a key

                                                                                                                                                                            since
                                                                                                                                                                            @@ -5648,17 +5900,20 @@
                                                                                                                                                                            handler: function
                                                                                                                                                                              • -
                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                • +
                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                              • Parameters

                                                                                                                                                                                • -
                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                  +
                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                -

                                                                                                                                                                                Returns void

                                                                                                                                                                                +

                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                              • @@ -5679,12 +5934,12 @@

                                                                                                                                                                              getBinary

                                                                                                                                                                            • -

                                                                                                                                                                              Get the value of a key - without decoding as utf-8

                                                                                                                                                                              +

                                                                                                                                                                              Get the value of a key - without decoding as utf-8

                                                                                                                                                                              since
                                                                                                                                                                              @@ -5709,17 +5964,20 @@
                                                                                                                                                                              handler: function
                                                                                                                                                                                • -
                                                                                                                                                                                • (result: AsyncResult<Buffer>): void
                                                                                                                                                                                  • +
                                                                                                                                                                                • (res: AsyncResult<Buffer>): void | Handler<AsyncResult<Buffer>>

                                                                                                                                                                                • Parameters

                                                                                                                                                                                  • -
                                                                                                                                                                                    result: AsyncResult<Buffer>
                                                                                                                                                                                    +
                                                                                                                                                                                    res: AsyncResult<Buffer>
                                                                                                                                                                                  -

                                                                                                                                                                                  Returns void

                                                                                                                                                                                  +

                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<Buffer>> +

                                                                                                                                                                                • @@ -5740,12 +5998,12 @@

                                                                                                                                                                                getbit

                                                                                                                                                                              • -

                                                                                                                                                                                Returns the bit value at offset in the string value stored at key

                                                                                                                                                                                +

                                                                                                                                                                                Returns the bit value at offset in the string value stored at key

                                                                                                                                                                                since
                                                                                                                                                                                @@ -5776,17 +6034,20 @@
                                                                                                                                                                                handler: function
                                                                                                                                                                                  • -
                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                    • +
                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                  • Parameters

                                                                                                                                                                                    • -
                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                      +
                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                    -

                                                                                                                                                                                    Returns void

                                                                                                                                                                                    +

                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                  • @@ -5807,12 +6068,12 @@

                                                                                                                                                                                  getrange

                                                                                                                                                                                • -

                                                                                                                                                                                  Get a substring of the string stored at a key

                                                                                                                                                                                  +

                                                                                                                                                                                  Get a substring of the string stored at a key

                                                                                                                                                                                  since
                                                                                                                                                                                  @@ -5849,17 +6110,20 @@
                                                                                                                                                                                  handler: function
                                                                                                                                                                                    • -
                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                      • +
                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                    • Parameters

                                                                                                                                                                                      • -
                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                        +
                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                      -

                                                                                                                                                                                      Returns void

                                                                                                                                                                                      +

                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                    • @@ -5880,12 +6144,12 @@

                                                                                                                                                                                    getset

                                                                                                                                                                                  • -

                                                                                                                                                                                    Set the string value of a key and return its old value

                                                                                                                                                                                    +

                                                                                                                                                                                    Set the string value of a key and return its old value

                                                                                                                                                                                    since
                                                                                                                                                                                    @@ -5916,17 +6180,20 @@
                                                                                                                                                                                    handler: function
                                                                                                                                                                                      • -
                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                        • +
                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                      • Parameters

                                                                                                                                                                                        • -
                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                          +
                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns void

                                                                                                                                                                                        +

                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                      • @@ -5947,12 +6214,12 @@

                                                                                                                                                                                      hdel

                                                                                                                                                                                    • -

                                                                                                                                                                                      Delete one or more hash fields

                                                                                                                                                                                      +

                                                                                                                                                                                      Delete one or more hash fields

                                                                                                                                                                                      since
                                                                                                                                                                                      @@ -5983,17 +6250,20 @@
                                                                                                                                                                                      handler: function
                                                                                                                                                                                        • -
                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                          • +
                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                        • Parameters

                                                                                                                                                                                          • -
                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                            +
                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                          -

                                                                                                                                                                                          Returns void

                                                                                                                                                                                          +

                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                        • @@ -6014,12 +6284,12 @@

                                                                                                                                                                                        hdelMany

                                                                                                                                                                                      • -

                                                                                                                                                                                        Delete one or more hash fields

                                                                                                                                                                                        +

                                                                                                                                                                                        Delete one or more hash fields

                                                                                                                                                                                        since
                                                                                                                                                                                        @@ -6050,17 +6320,20 @@
                                                                                                                                                                                        handler: function
                                                                                                                                                                                          • -
                                                                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                                                                            • +
                                                                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                          • Parameters

                                                                                                                                                                                            • -
                                                                                                                                                                                              result: AsyncResult<number>
                                                                                                                                                                                              +
                                                                                                                                                                                              res: AsyncResult<number>
                                                                                                                                                                                            -

                                                                                                                                                                                            Returns void

                                                                                                                                                                                            +

                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                          • @@ -6081,12 +6354,12 @@

                                                                                                                                                                                          hexists

                                                                                                                                                                                        • -

                                                                                                                                                                                          Determine if a hash field exists

                                                                                                                                                                                          +

                                                                                                                                                                                          Determine if a hash field exists

                                                                                                                                                                                          since
                                                                                                                                                                                          @@ -6117,17 +6390,20 @@
                                                                                                                                                                                          handler: function
                                                                                                                                                                                            • -
                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                              • +
                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                            • Parameters

                                                                                                                                                                                              • -
                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                +
                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                              -

                                                                                                                                                                                              Returns void

                                                                                                                                                                                              +

                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                            • @@ -6148,12 +6424,12 @@

                                                                                                                                                                                            hget

                                                                                                                                                                                          • -

                                                                                                                                                                                            Get the value of a hash field

                                                                                                                                                                                            +

                                                                                                                                                                                            Get the value of a hash field

                                                                                                                                                                                            since
                                                                                                                                                                                            @@ -6184,17 +6460,20 @@
                                                                                                                                                                                            handler: function
                                                                                                                                                                                              • -
                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                • +
                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                • -
                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                  +
                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                -

                                                                                                                                                                                                Returns void

                                                                                                                                                                                                +

                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                              • @@ -6215,12 +6494,12 @@

                                                                                                                                                                                              hgetall

                                                                                                                                                                                            • -

                                                                                                                                                                                              Get all the fields and values in a hash

                                                                                                                                                                                              +

                                                                                                                                                                                              Get all the fields and values in a hash

                                                                                                                                                                                              since
                                                                                                                                                                                              @@ -6245,17 +6524,20 @@
                                                                                                                                                                                              handler: function
                                                                                                                                                                                                • -
                                                                                                                                                                                                • (result: AsyncResult<any>): void
                                                                                                                                                                                                  • +
                                                                                                                                                                                                • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                  • -
                                                                                                                                                                                                    result: AsyncResult<any>
                                                                                                                                                                                                    +
                                                                                                                                                                                                    res: AsyncResult<object>
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<object>> +

                                                                                                                                                                                                • @@ -6276,12 +6558,12 @@

                                                                                                                                                                                                hincrby

                                                                                                                                                                                              • -

                                                                                                                                                                                                Increment the integer value of a hash field by the given number

                                                                                                                                                                                                +

                                                                                                                                                                                                Increment the integer value of a hash field by the given number

                                                                                                                                                                                                since
                                                                                                                                                                                                @@ -6318,17 +6600,20 @@
                                                                                                                                                                                                handler: function
                                                                                                                                                                                                  • -
                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • -
                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                      +
                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                  • @@ -6349,12 +6634,12 @@

                                                                                                                                                                                                  hincrbyfloat

                                                                                                                                                                                                • -

                                                                                                                                                                                                  Increment the float value of a hash field by the given amount

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Increment the float value of a hash field by the given amount

                                                                                                                                                                                                  since
                                                                                                                                                                                                  @@ -6391,17 +6676,20 @@
                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                    • -
                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                      • +
                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • -
                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                        +
                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                    • @@ -6422,12 +6710,12 @@

                                                                                                                                                                                                    hkeys

                                                                                                                                                                                                  • -

                                                                                                                                                                                                    Get all the fields in a hash

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Get all the fields in a hash

                                                                                                                                                                                                    since
                                                                                                                                                                                                    @@ -6452,17 +6740,20 @@
                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        • -
                                                                                                                                                                                                          result: AsyncResult<any[]>
                                                                                                                                                                                                          +
                                                                                                                                                                                                          res: AsyncResult<any[]>
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                        +

                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                      • @@ -6483,12 +6774,12 @@

                                                                                                                                                                                                      hlen

                                                                                                                                                                                                    • -

                                                                                                                                                                                                      Get the number of fields in a hash

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Get the number of fields in a hash

                                                                                                                                                                                                      since
                                                                                                                                                                                                      @@ -6513,17 +6804,20 @@
                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                        • -
                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                          • +
                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                          • -
                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                            +
                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                        • @@ -6544,12 +6838,12 @@

                                                                                                                                                                                                        hmget

                                                                                                                                                                                                      • -

                                                                                                                                                                                                        Get the values of all the given hash fields

                                                                                                                                                                                                        +

                                                                                                                                                                                                        Get the values of all the given hash fields

                                                                                                                                                                                                        since
                                                                                                                                                                                                        @@ -6580,17 +6874,20 @@
                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                          • -
                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                            • +
                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                            • -
                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                              +
                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                          • @@ -6611,12 +6908,12 @@

                                                                                                                                                                                                          hmset

                                                                                                                                                                                                        • -

                                                                                                                                                                                                          Set multiple hash fields to multiple values

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Set multiple hash fields to multiple values

                                                                                                                                                                                                          since
                                                                                                                                                                                                          @@ -6638,6 +6935,11 @@
                                                                                                                                                                                                          values: object

                                                                                                                                                                                                          Map of field:value pairs

                                                                                                                                                                                                          +
                                                                                                                                                                                                            +
                                                                                                                                                                                                          • +
                                                                                                                                                                                                            [key: string]: any
                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                        • handler: function
                                                                                                                                                                                                          @@ -6647,17 +6949,20 @@
                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                            • -
                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                              • +
                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                              • -
                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                +
                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                              +

                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                            • @@ -6678,12 +6983,12 @@

                                                                                                                                                                                                            hscan

                                                                                                                                                                                                          • -

                                                                                                                                                                                                            Incrementally iterate hash fields and associated values

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Incrementally iterate hash fields and associated values

                                                                                                                                                                                                            since
                                                                                                                                                                                                            @@ -6720,17 +7025,20 @@
                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                              • -
                                                                                                                                                                                                              • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                • +
                                                                                                                                                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                • -
                                                                                                                                                                                                                  result: AsyncResult<any[]>
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  res: AsyncResult<any[]>
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                              • @@ -6751,12 +7059,12 @@

                                                                                                                                                                                                              hset

                                                                                                                                                                                                            • -

                                                                                                                                                                                                              Set the string value of a hash field

                                                                                                                                                                                                              +

                                                                                                                                                                                                              Set the string value of a hash field

                                                                                                                                                                                                              since
                                                                                                                                                                                                              @@ -6793,17 +7101,20 @@
                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                • -
                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                • @@ -6824,12 +7135,12 @@

                                                                                                                                                                                                                hsetnx

                                                                                                                                                                                                              • -

                                                                                                                                                                                                                Set the value of a hash field, only if the field does not exist

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Set the value of a hash field, only if the field does not exist

                                                                                                                                                                                                                since
                                                                                                                                                                                                                @@ -6866,17 +7177,20 @@
                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                  • @@ -6897,12 +7211,12 @@

                                                                                                                                                                                                                  hstrlen

                                                                                                                                                                                                                • -

                                                                                                                                                                                                                  Get the length of the value of a hash field.

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Get the length of the value of a hash field.

                                                                                                                                                                                                                  since
                                                                                                                                                                                                                  @@ -6930,17 +7244,20 @@
                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                    • @@ -6961,12 +7278,12 @@

                                                                                                                                                                                                                    hvals

                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                    Get all the values in a hash

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Get all the values in a hash

                                                                                                                                                                                                                    since
                                                                                                                                                                                                                    @@ -6991,17 +7308,20 @@
                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                      • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                          result: AsyncResult<any[]>
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          res: AsyncResult<any[]>
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                      • @@ -7022,12 +7342,12 @@

                                                                                                                                                                                                                      incr

                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                      Increment the integer value of a key by one

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Increment the integer value of a key by one

                                                                                                                                                                                                                      since
                                                                                                                                                                                                                      @@ -7052,17 +7372,20 @@
                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                        • @@ -7083,12 +7406,12 @@

                                                                                                                                                                                                                        incrby

                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                        Increment the integer value of a key by the given amount

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Increment the integer value of a key by the given amount

                                                                                                                                                                                                                        since
                                                                                                                                                                                                                        @@ -7119,17 +7442,20 @@
                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                              result: AsyncResult<number>
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              res: AsyncResult<number>
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                          • @@ -7150,12 +7476,12 @@

                                                                                                                                                                                                                          incrbyfloat

                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                          Increment the float value of a key by the given amount

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Increment the float value of a key by the given amount

                                                                                                                                                                                                                          since
                                                                                                                                                                                                                          @@ -7186,17 +7512,20 @@
                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                            • @@ -7217,12 +7546,12 @@

                                                                                                                                                                                                                            info

                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                            Get information and statistics about the server

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Get information and statistics about the server

                                                                                                                                                                                                                            since
                                                                                                                                                                                                                            @@ -7241,17 +7570,20 @@
                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                              • (result: AsyncResult<any>): void
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                              • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                  result: AsyncResult<any>
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  res: AsyncResult<object>
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<object>> +

                                                                                                                                                                                                                              • @@ -7272,12 +7604,12 @@

                                                                                                                                                                                                                              infoSection

                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                              Get information and statistics about the server

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Get information and statistics about the server

                                                                                                                                                                                                                              since
                                                                                                                                                                                                                              @@ -7302,17 +7634,20 @@
                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                • (result: AsyncResult<any>): void
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                • (res: AsyncResult<object>): void | Handler<AsyncResult<object>>

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                    result: AsyncResult<any>
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    res: AsyncResult<object>
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<object>> +

                                                                                                                                                                                                                                • @@ -7333,12 +7668,12 @@

                                                                                                                                                                                                                                keys

                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                Find all keys matching the given pattern

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Find all keys matching the given pattern

                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                @@ -7363,17 +7698,20 @@
                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                  • @@ -7394,12 +7732,12 @@

                                                                                                                                                                                                                                  lastsave

                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                  Get the UNIX time stamp of the last successful save to disk

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Get the UNIX time stamp of the last successful save to disk

                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                  @@ -7415,17 +7753,20 @@
                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                    • @@ -7446,12 +7787,12 @@

                                                                                                                                                                                                                                    lindex

                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                    Get an element from a list by its index

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Get an element from a list by its index

                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    @@ -7482,17 +7823,20 @@
                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                      • @@ -7513,12 +7857,12 @@

                                                                                                                                                                                                                                      linsert

                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                      Insert an element before or after another element in a list

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Insert an element before or after another element in a list

                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                      @@ -7561,17 +7905,20 @@
                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                        • @@ -7592,12 +7939,12 @@

                                                                                                                                                                                                                                        llen

                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                        Get the length of a list

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Get the length of a list

                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                        @@ -7622,17 +7969,20 @@
                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                              result: AsyncResult<number>
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              res: AsyncResult<number>
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                          • @@ -7653,12 +8003,12 @@

                                                                                                                                                                                                                                          lpop

                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                          Remove and get the first element in a list

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Remove and get the first element in a list

                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                          @@ -7683,17 +8033,20 @@
                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                            • @@ -7714,12 +8067,12 @@

                                                                                                                                                                                                                                            lpush

                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                            Prepend one value to a list

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Prepend one value to a list

                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                            @@ -7750,17 +8103,20 @@
                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                              • @@ -7781,12 +8137,12 @@

                                                                                                                                                                                                                                              lpushMany

                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                              Prepend one or multiple values to a list

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Prepend one or multiple values to a list

                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                              @@ -7817,17 +8173,20 @@
                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                • @@ -7848,12 +8207,12 @@

                                                                                                                                                                                                                                                lpushx

                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                Prepend a value to a list, only if the list exists

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Prepend a value to a list, only if the list exists

                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                @@ -7884,17 +8243,20 @@
                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                  • @@ -7915,12 +8277,12 @@

                                                                                                                                                                                                                                                  lrange

                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                  Get a range of elements from a list

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Get a range of elements from a list

                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                  @@ -7957,17 +8319,20 @@
                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                    • @@ -7988,12 +8353,12 @@

                                                                                                                                                                                                                                                    lrem

                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                    Remove elements from a list

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Remove elements from a list

                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                    @@ -8030,17 +8395,20 @@
                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                      • @@ -8061,12 +8429,12 @@

                                                                                                                                                                                                                                                      lset

                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                      Set the value of an element in a list by its index

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Set the value of an element in a list by its index

                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                      @@ -8103,17 +8471,20 @@
                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                        • @@ -8134,12 +8505,12 @@

                                                                                                                                                                                                                                                        ltrim

                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                        Trim a list to the specified range

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Trim a list to the specified range

                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                        @@ -8176,17 +8547,20 @@
                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                          • @@ -8207,12 +8581,12 @@

                                                                                                                                                                                                                                                          mget

                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                          Get the value of the given key

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Get the value of the given key

                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                          @@ -8237,17 +8611,20 @@
                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                            • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                res: AsyncResult<any[]>
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                            • @@ -8268,12 +8645,12 @@

                                                                                                                                                                                                                                                            mgetMany

                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                            Get the values of all the given keys

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Get the values of all the given keys

                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                            @@ -8298,17 +8675,20 @@
                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                              • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                  result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                              • @@ -8329,12 +8709,12 @@

                                                                                                                                                                                                                                                              migrate

                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                              Atomically transfer a key from a Redis instance to another one.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Atomically transfer a key from a Redis instance to another one.

                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                              @@ -8386,17 +8766,20 @@
                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                • @@ -8417,12 +8800,12 @@

                                                                                                                                                                                                                                                                monitor

                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                Listen for all requests received by the server in real time

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Listen for all requests received by the server in real time

                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                @@ -8438,17 +8821,20 @@
                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                  • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                      result: AsyncResult<void>
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      res: AsyncResult<void>
                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                  • @@ -8469,12 +8855,12 @@

                                                                                                                                                                                                                                                                  move

                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                  Move a key to another database

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Move a key to another database

                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                  @@ -8505,17 +8891,20 @@
                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                    • @@ -8536,12 +8925,12 @@

                                                                                                                                                                                                                                                                    mset

                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                    Set multiple keys to multiple values

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Set multiple keys to multiple values

                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                    @@ -8557,6 +8946,11 @@
                                                                                                                                                                                                                                                                    keyvals: object

                                                                                                                                                                                                                                                                    Key value pairs to set

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                      [key: string]: any
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                  • handler: function
                                                                                                                                                                                                                                                                    @@ -8566,17 +8960,20 @@
                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                      • @@ -8597,12 +8994,12 @@

                                                                                                                                                                                                                                                                      msetnx

                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                      Set multiple keys to multiple values, only if none of the keys exist

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Set multiple keys to multiple values, only if none of the keys exist

                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                      @@ -8618,6 +9015,11 @@
                                                                                                                                                                                                                                                                      keyvals: object

                                                                                                                                                                                                                                                                      Key value pairs to set

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                        [key: string]: any
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                    • handler: function
                                                                                                                                                                                                                                                                      @@ -8627,17 +9029,20 @@
                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                        • @@ -8658,12 +9063,12 @@

                                                                                                                                                                                                                                                                        object

                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                        Inspect the internals of Redis objects

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Inspect the internals of Redis objects

                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                        @@ -8694,17 +9099,20 @@
                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                          • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                              result: AsyncResult<void>
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              res: AsyncResult<void>
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                          • @@ -8725,12 +9133,12 @@

                                                                                                                                                                                                                                                                          persist

                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                          Remove the expiration from a key

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Remove the expiration from a key

                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                          @@ -8755,17 +9163,20 @@
                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                            • @@ -8786,12 +9197,12 @@

                                                                                                                                                                                                                                                                            pexpire

                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                            Set a key's time to live in milliseconds

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Set a key's time to live in milliseconds

                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                            @@ -8822,17 +9233,20 @@
                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                              • @@ -8853,12 +9267,12 @@

                                                                                                                                                                                                                                                                              pexpireat

                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                              Set the expiration for a key as a UNIX timestamp specified in milliseconds

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Set the expiration for a key as a UNIX timestamp specified in milliseconds

                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                              @@ -8889,17 +9303,20 @@
                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                • @@ -8920,12 +9337,12 @@

                                                                                                                                                                                                                                                                                pfadd

                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                Adds the specified element to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Adds the specified element to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                @@ -8956,17 +9373,20 @@
                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                  • @@ -8987,12 +9407,12 @@

                                                                                                                                                                                                                                                                                  pfaddMany

                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                  Adds the specified elements to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Adds the specified elements to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                  @@ -9023,17 +9443,20 @@
                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                    • @@ -9054,12 +9477,12 @@

                                                                                                                                                                                                                                                                                    pfcount

                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                    Return the approximated cardinality of the set observed by the HyperLogLog at key.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Return the approximated cardinality of the set observed by the HyperLogLog at key.

                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                    @@ -9084,17 +9507,20 @@
                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                      • @@ -9115,12 +9541,12 @@

                                                                                                                                                                                                                                                                                      pfcountMany

                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                      Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                      @@ -9145,17 +9571,20 @@
                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                        • @@ -9176,12 +9605,12 @@

                                                                                                                                                                                                                                                                                        pfmerge

                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                        Merge N different HyperLogLogs into a single one.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Merge N different HyperLogLogs into a single one.

                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                        @@ -9212,17 +9641,20 @@
                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                          • @@ -9243,12 +9675,12 @@

                                                                                                                                                                                                                                                                                          ping

                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                          Ping the server

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Ping the server

                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                          @@ -9264,17 +9696,20 @@
                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                            • @@ -9295,12 +9730,12 @@

                                                                                                                                                                                                                                                                                            psetex

                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                            Set the value and expiration in milliseconds of a key

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Set the value and expiration in milliseconds of a key

                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                            @@ -9337,17 +9772,20 @@
                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                              • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                  result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                              • @@ -9368,12 +9806,12 @@

                                                                                                                                                                                                                                                                                              psubscribe

                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                              Listen for messages published to channels matching the given pattern

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Listen for messages published to channels matching the given pattern

                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                              @@ -9398,17 +9836,20 @@
                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                • @@ -9429,12 +9870,12 @@

                                                                                                                                                                                                                                                                                                psubscribeMany

                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                Listen for messages published to channels matching the given patterns

                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Listen for messages published to channels matching the given patterns

                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                @@ -9459,17 +9900,20 @@
                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                  • @@ -9490,12 +9934,12 @@

                                                                                                                                                                                                                                                                                                  pttl

                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                  Get the time to live for a key in milliseconds

                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Get the time to live for a key in milliseconds

                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                  @@ -9520,17 +9964,20 @@
                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                    • @@ -9551,12 +9998,12 @@

                                                                                                                                                                                                                                                                                                    publish

                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                    Post a message to a channel

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Post a message to a channel

                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                    @@ -9587,17 +10034,20 @@
                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                      • @@ -9618,12 +10068,12 @@

                                                                                                                                                                                                                                                                                                      pubsubChannels

                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                      Lists the currently active channels - only those matching the pattern

                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Lists the currently active channels - only those matching the pattern

                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                      @@ -9648,17 +10098,20 @@
                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                        • @@ -9679,12 +10132,12 @@

                                                                                                                                                                                                                                                                                                        pubsubNumpat

                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                        Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command)

                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command)

                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                        @@ -9703,17 +10156,20 @@
                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                              result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                          • @@ -9734,12 +10190,12 @@

                                                                                                                                                                                                                                                                                                          pubsubNumsub

                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                          Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels

                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels

                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                          @@ -9764,17 +10220,20 @@
                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                            • @@ -9795,12 +10254,12 @@

                                                                                                                                                                                                                                                                                                            punsubscribe

                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                            Stop listening for messages posted to channels matching the given patterns

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Stop listening for messages posted to channels matching the given patterns

                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                            @@ -9825,17 +10284,20 @@
                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                  result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                              • @@ -9856,12 +10318,12 @@

                                                                                                                                                                                                                                                                                                              randomkey

                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                              Return a random key from the keyspace

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Return a random key from the keyspace

                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                              @@ -9877,17 +10339,20 @@
                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                • @@ -9908,12 +10373,12 @@

                                                                                                                                                                                                                                                                                                                rename

                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                Rename a key

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Rename a key

                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                @@ -9944,17 +10409,20 @@
                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                  • @@ -9975,12 +10443,12 @@

                                                                                                                                                                                                                                                                                                                  renamenx

                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                  Rename a key, only if the new key does not exist

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Rename a key, only if the new key does not exist

                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                  @@ -10011,17 +10479,20 @@
                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                    • @@ -10042,12 +10513,12 @@

                                                                                                                                                                                                                                                                                                                    restore

                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                    Create a key using the provided serialized value, previously obtained using DUMP.

                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Create a key using the provided serialized value, previously obtained using DUMP.

                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                    @@ -10084,17 +10555,20 @@
                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                      • @@ -10115,12 +10589,12 @@

                                                                                                                                                                                                                                                                                                                      role

                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                      Return the role of the instance in the context of replication

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Return the role of the instance in the context of replication

                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                      @@ -10136,17 +10610,20 @@
                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                        • @@ -10167,12 +10644,12 @@

                                                                                                                                                                                                                                                                                                                        rpop

                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                        Remove and get the last element in a list

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Remove and get the last element in a list

                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                        @@ -10197,17 +10674,20 @@
                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                          • @@ -10228,12 +10708,12 @@

                                                                                                                                                                                                                                                                                                                          rpoplpush

                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                          Remove the last element in a list, append it to another list and return it

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Remove the last element in a list, append it to another list and return it

                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                          @@ -10264,17 +10744,20 @@
                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                            • @@ -10295,12 +10778,12 @@

                                                                                                                                                                                                                                                                                                                            rpush

                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                            Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                            @@ -10331,17 +10814,20 @@
                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                              • @@ -10362,12 +10848,12 @@

                                                                                                                                                                                                                                                                                                                              rpushMany

                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                              Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                              @@ -10398,17 +10884,20 @@
                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                • @@ -10429,12 +10918,12 @@

                                                                                                                                                                                                                                                                                                                                rpushx

                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                Append a value to a list, only if the list exists

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Append a value to a list, only if the list exists

                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                @@ -10465,17 +10954,20 @@
                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                  • @@ -10496,12 +10988,12 @@

                                                                                                                                                                                                                                                                                                                                  sadd

                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                  Add a member to a set

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Add a member to a set

                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                  @@ -10532,17 +11024,20 @@
                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                    • @@ -10563,12 +11058,12 @@

                                                                                                                                                                                                                                                                                                                                    saddMany

                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                    Add one or more members to a set

                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Add one or more members to a set

                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                    @@ -10599,17 +11094,20 @@
                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                      • @@ -10630,12 +11128,12 @@

                                                                                                                                                                                                                                                                                                                                      save

                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                      Synchronously save the dataset to disk

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Synchronously save the dataset to disk

                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                      @@ -10651,17 +11149,20 @@
                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                        • @@ -10682,12 +11183,12 @@

                                                                                                                                                                                                                                                                                                                                        scan

                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                        Incrementally iterate the keys space

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Incrementally iterate the keys space

                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                        @@ -10718,17 +11219,20 @@
                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                          • @@ -10749,12 +11253,12 @@

                                                                                                                                                                                                                                                                                                                                          scard

                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                          Get the number of members in a set

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Get the number of members in a set

                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                          @@ -10779,17 +11283,20 @@
                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                            • @@ -10810,12 +11317,12 @@

                                                                                                                                                                                                                                                                                                                                            scriptDebug

                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                            Set the debug mode for executed scripts.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Set the debug mode for executed scripts.

                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                            @@ -10837,17 +11344,20 @@
                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                              • @@ -10868,12 +11378,12 @@

                                                                                                                                                                                                                                                                                                                                              scriptExists

                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                              Check existence of script in the script cache.

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Check existence of script in the script cache.

                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                              @@ -10898,17 +11408,20 @@
                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                • @@ -10929,12 +11442,12 @@

                                                                                                                                                                                                                                                                                                                                                scriptExistsMany

                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                Check existence of scripts in the script cache.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Check existence of scripts in the script cache.

                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                @@ -10959,17 +11472,20 @@
                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                  • @@ -10990,12 +11506,12 @@

                                                                                                                                                                                                                                                                                                                                                  scriptFlush

                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                  Remove all the scripts from the script cache.

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Remove all the scripts from the script cache.

                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                  @@ -11011,17 +11527,20 @@
                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                    • @@ -11042,12 +11561,12 @@

                                                                                                                                                                                                                                                                                                                                                    scriptKill

                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                    Kill the script currently in execution.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Kill the script currently in execution.

                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                    @@ -11063,17 +11582,20 @@
                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                      • @@ -11094,12 +11616,12 @@

                                                                                                                                                                                                                                                                                                                                                      scriptLoad

                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                      Load the specified Lua script into the script cache.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Load the specified Lua script into the script cache.

                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                      @@ -11124,17 +11646,20 @@
                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                        • @@ -11155,12 +11680,12 @@

                                                                                                                                                                                                                                                                                                                                                        sdiff

                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                        Subtract multiple sets

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Subtract multiple sets

                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                        @@ -11191,17 +11716,20 @@
                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                          • @@ -11222,12 +11750,12 @@

                                                                                                                                                                                                                                                                                                                                                          sdiffstore

                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                          Subtract multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Subtract multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                          @@ -11264,17 +11792,20 @@
                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                            • @@ -11295,12 +11826,12 @@

                                                                                                                                                                                                                                                                                                                                                            select

                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                            Change the selected database for the current connection

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Change the selected database for the current connection

                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                            @@ -11325,17 +11856,20 @@
                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                              • @@ -11356,12 +11890,12 @@

                                                                                                                                                                                                                                                                                                                                                              set

                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                              Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                              @@ -11392,17 +11926,20 @@
                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                • @@ -11423,12 +11960,12 @@

                                                                                                                                                                                                                                                                                                                                                                setBinary

                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                Set the binary string value of a key - without encoding as utf-8

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Set the binary string value of a key - without encoding as utf-8

                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                @@ -11459,17 +11996,20 @@
                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                  • @@ -11490,12 +12030,12 @@

                                                                                                                                                                                                                                                                                                                                                                  setBinaryWithOptions

                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                  Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                  @@ -11532,17 +12072,20 @@
                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                    • @@ -11563,12 +12106,12 @@

                                                                                                                                                                                                                                                                                                                                                                    setWithOptions

                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                    Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                    @@ -11605,17 +12148,20 @@
                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                      • @@ -11636,12 +12182,12 @@

                                                                                                                                                                                                                                                                                                                                                                      setbit

                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                      Sets or clears the bit at offset in the string value stored at key

                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Sets or clears the bit at offset in the string value stored at key

                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                      @@ -11678,17 +12224,20 @@
                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                        • @@ -11709,12 +12258,12 @@

                                                                                                                                                                                                                                                                                                                                                                        setex

                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                        Set the value and expiration of a key

                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Set the value and expiration of a key

                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                        @@ -11751,17 +12300,20 @@
                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                          • @@ -11782,12 +12334,12 @@

                                                                                                                                                                                                                                                                                                                                                                          setnx

                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                          Set the value of a key, only if the key does not exist

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Set the value of a key, only if the key does not exist

                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                          @@ -11818,17 +12370,20 @@
                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                            • @@ -11849,12 +12404,12 @@

                                                                                                                                                                                                                                                                                                                                                                            setrange

                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                            Overwrite part of a string at key starting at the specified offset

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Overwrite part of a string at key starting at the specified offset

                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                            @@ -11891,17 +12446,20 @@
                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                              • @@ -11922,12 +12480,12 @@

                                                                                                                                                                                                                                                                                                                                                                              sinter

                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                              Intersect multiple sets

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Intersect multiple sets

                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                              @@ -11952,17 +12510,20 @@
                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                • @@ -11983,12 +12544,12 @@

                                                                                                                                                                                                                                                                                                                                                                                sinterstore

                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                Intersect multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Intersect multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                @@ -12019,17 +12580,20 @@
                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                  • @@ -12050,12 +12614,12 @@

                                                                                                                                                                                                                                                                                                                                                                                  sismember

                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                  Determine if a given value is a member of a set

                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Determine if a given value is a member of a set

                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                  @@ -12086,17 +12650,20 @@
                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                    • @@ -12117,12 +12684,12 @@

                                                                                                                                                                                                                                                                                                                                                                                    slaveof

                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                    Make the server a slave of another instance

                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Make the server a slave of another instance

                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                    @@ -12153,17 +12720,20 @@
                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                      • @@ -12184,12 +12754,12 @@

                                                                                                                                                                                                                                                                                                                                                                                      slaveofNoone

                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                      Make this server a master

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Make this server a master

                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                      @@ -12208,17 +12778,20 @@
                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                        • @@ -12239,12 +12812,12 @@

                                                                                                                                                                                                                                                                                                                                                                                        slowlogGet

                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                        Read the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Read the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                        @@ -12269,17 +12842,20 @@
                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                          • @@ -12300,12 +12876,12 @@

                                                                                                                                                                                                                                                                                                                                                                                          slowlogLen

                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                          Get the length of the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Get the length of the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                          @@ -12324,17 +12900,20 @@
                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                            • @@ -12355,12 +12934,12 @@

                                                                                                                                                                                                                                                                                                                                                                                            slowlogReset

                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                            Reset the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Reset the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                            @@ -12379,17 +12958,20 @@
                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                              • @@ -12410,12 +12992,12 @@

                                                                                                                                                                                                                                                                                                                                                                                              smembers

                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                              Get all the members in a set

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Get all the members in a set

                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                              @@ -12440,17 +13022,20 @@
                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                • @@ -12471,12 +13056,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                smove

                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                Move a member from one set to another

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Move a member from one set to another

                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                @@ -12513,17 +13098,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -12544,12 +13132,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                  sort

                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                  Sort the elements in a list, set or sorted set

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Sort the elements in a list, set or sorted set

                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                  @@ -12580,17 +13168,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -12611,12 +13202,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                    spop

                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                    Remove and return a random member from a set

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Remove and return a random member from a set

                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                    @@ -12641,17 +13232,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -12672,12 +13266,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                      spopMany

                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                      Remove and return random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Remove and return random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                      @@ -12708,17 +13302,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -12739,12 +13336,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                        srandmember

                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                        Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                        @@ -12769,17 +13366,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -12800,12 +13400,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                          srandmemberCount

                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                          Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                          @@ -12836,17 +13436,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -12867,12 +13470,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                            srem

                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                            Remove one member from a set

                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Remove one member from a set

                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                            @@ -12903,17 +13506,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -12934,12 +13540,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                              sremMany

                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                              Remove one or more members from a set

                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Remove one or more members from a set

                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                              @@ -12970,17 +13576,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -13001,12 +13610,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                sscan

                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                Incrementally iterate Set elements

                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Incrementally iterate Set elements

                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                @@ -13043,17 +13652,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -13074,12 +13686,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                  strlen

                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                  Get the length of the value stored in a key

                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Get the length of the value stored in a key

                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -13104,17 +13716,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -13135,12 +13750,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                    subscribe

                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                    Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -13165,17 +13780,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -13196,12 +13814,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                      subscribeMany

                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                      Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -13226,17 +13844,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -13257,12 +13878,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                        sunion

                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                        Add multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Add multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -13287,17 +13908,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -13318,12 +13942,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                          sunionstore

                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                          Add multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Add multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -13354,17 +13978,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -13385,12 +14012,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                            swapdb

                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                            Swaps two Redis databases

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Swaps two Redis databases

                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -13421,17 +14048,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -13452,12 +14082,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                              sync

                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                              Internal command used for replication

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Internal command used for replication

                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -13473,17 +14103,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -13504,12 +14137,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                time

                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                Return the current server time

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Return the current server time

                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -13525,17 +14158,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -13556,12 +14192,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                  touch

                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Alters the last access time of a key(s). Returns the number of existing keys specified.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Alters the last access time of a key(s). Returns the number of existing keys specified.

                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -13583,17 +14219,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -13614,12 +14253,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                    touchMany

                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Alters the last access time of a key(s). Returns the number of existing keys specified.

                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Alters the last access time of a key(s). Returns the number of existing keys specified.

                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -13641,17 +14280,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -13672,12 +14314,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                      transaction

                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a RedisTransaction instance

                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a RedisTransaction instance

                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns RedisTransaction

                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -13695,12 +14337,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                      ttl

                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the time to live for a key

                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the time to live for a key

                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -13725,17 +14367,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -13756,12 +14401,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                        type

                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Determine the type stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Determine the type stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -13786,17 +14431,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -13817,12 +14465,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                          unlink

                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                          Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -13847,17 +14495,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -13878,12 +14529,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                            unlinkMany

                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete multiple keys asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete multiple keys asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -13908,17 +14559,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -13939,12 +14593,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                              unsubscribe

                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Stop listening for messages posted to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Stop listening for messages posted to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -13969,17 +14623,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -14000,12 +14657,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                wait

                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Wait for the synchronous replication of all the write commands sent in the context of the current connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Wait for the synchronous replication of all the write commands sent in the context of the current connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -14030,17 +14687,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -14061,12 +14721,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                  zadd

                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -14103,17 +14763,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -14128,18 +14791,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                    zaddMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • zaddMany(key: string, members: Map<String, number>, handler: function): RedisClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • zaddMany(key: string, members: object, handler: function): RedisClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -14157,10 +14820,15 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                      key: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      members: Map<String, number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      members: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                      New member keys and their scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        [key: string]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -14170,17 +14838,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -14201,12 +14872,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                        zcard

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the number of members in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the number of members in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -14231,17 +14902,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -14262,12 +14936,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                          zcount

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Count the members in a sorted set with scores within the given values

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Count the members in a sorted set with scores within the given values

                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -14304,17 +14978,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -14335,12 +15012,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                            zincrby

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Increment the score of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Increment the score of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -14377,17 +15054,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -14408,12 +15088,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                              zinterstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Intersect multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Intersect multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -14450,17 +15130,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -14475,18 +15158,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                zinterstoreWeighed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Intersect multiple sorted sets and store the resulting sorted set in a new key using weights for scoring

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Intersect multiple sorted sets and store the resulting sorted set in a new key using weights for scoring

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -14504,10 +15187,15 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  destkey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sets: Map<String, number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sets: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of keys identifying sorted sets to intersect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [key: string]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • options: AggregateOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -14523,17 +15211,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -14554,12 +15245,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zlexcount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Count the number of members in a sorted set between a given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Count the number of members in a sorted set between a given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -14596,17 +15287,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -14627,12 +15321,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -14669,17 +15363,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -14700,12 +15397,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zrangeWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -14748,17 +15445,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -14779,12 +15479,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zrangebylex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a range of members in a sorted set, by lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a range of members in a sorted set, by lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -14827,17 +15527,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -14858,12 +15561,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zrangebyscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return a range of members in a sorted set, by score

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return a range of members in a sorted set, by score

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -14906,17 +15609,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -14937,12 +15643,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zrank

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Determine the index of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Determine the index of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -14973,17 +15679,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -15004,12 +15713,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zrem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove one member from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove one member from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -15040,17 +15749,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -15071,12 +15783,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zremMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Remove one or more members from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Remove one or more members from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -15107,17 +15819,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -15138,12 +15853,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zremrangebylex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove all members in a sorted set between the given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove all members in a sorted set between the given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -15180,17 +15895,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -15211,12 +15929,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zremrangebyrank

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove all members in a sorted set within the given indexes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove all members in a sorted set within the given indexes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -15253,17 +15971,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -15284,12 +16005,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zremrangebyscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Remove all members in a sorted set within the given scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Remove all members in a sorted set within the given scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -15323,17 +16044,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -15354,12 +16078,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zrevrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a range of members in a sorted set, by index, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a range of members in a sorted set, by index, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -15402,17 +16126,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -15433,12 +16160,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zrevrangebylex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return a range of members in a sorted set, by score, between the given lexicographical range with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return a range of members in a sorted set, by score, between the given lexicographical range with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -15481,17 +16208,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -15512,12 +16242,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zrevrangebyscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return a range of members in a sorted set, by score, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return a range of members in a sorted set, by score, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -15560,17 +16290,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -15591,12 +16324,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zrevrank

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Determine the index of a member in a sorted set, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Determine the index of a member in a sorted set, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -15627,17 +16360,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<number>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<number>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -15658,12 +16394,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zscan

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Incrementally iterate sorted sets elements and associated scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Incrementally iterate sorted sets elements and associated scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -15700,17 +16436,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -15731,12 +16470,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the score associated with the given member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the score associated with the given member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -15767,17 +16506,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -15798,12 +16540,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zunionstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -15840,17 +16582,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -107,12 +107,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ckquorum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover. This command should be used in monitoring systems to check if a Sentinel deployment is ok.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -133,17 +133,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -164,12 +167,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        close

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Close the client - when it is fully closed the handler will be called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Close the client - when it is fully closed the handler will be called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -181,17 +184,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -212,12 +218,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          failover

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels (however a new version of the configuration will be published so that the other Sentinels will update their configurations)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -238,17 +244,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -269,12 +278,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flushConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Force Sentinel to rewrite its configuration on disk, including the current Sentinel state. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Force Sentinel to rewrite its configuration on disk, including the current Sentinel state. Normally Sentinel rewrites the configuration every time something changes in its state (in the context of the subset of the state which is persisted on disk across restart). However sometimes it is possible that the configuration file is lost because of operation errors, @@ -293,17 +302,20 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -324,12 +336,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getMasterAddrByName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return the ip and port number of the master with that name. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return the ip and port number of the master with that name. If a failover is in progress or terminated successfully for this master it returns the address and port of the promoted slave

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -350,17 +362,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -381,12 +396,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                master

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show the state and info of the specified master

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show the state and info of the specified master

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -405,17 +420,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -436,12 +454,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  masters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show a list of monitored masters and their state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show a list of monitored masters and their state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -454,17 +472,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -485,12 +506,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Reset all the masters with matching name. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Reset all the masters with matching name. The pattern argument is a glob-style pattern. The reset process clears any previous state in a master (including a failover in pro

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -511,17 +532,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -542,12 +566,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sentinels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show a list of sentinel instances for this master, and their state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show a list of sentinel instances for this master, and their state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -566,17 +590,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -597,12 +624,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        slaves

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show a list of slaves for this master, and their state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show a list of slaves for this master, and their state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -621,17 +648,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -652,7 +682,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Static create

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/@vertx/redis-client/classes/redistransaction.html b/docs/@vertx/redis/classes/redistransaction.html similarity index 65% rename from docs/@vertx/redis-client/classes/redistransaction.html rename to docs/@vertx/redis/classes/redistransaction.html index cf4dfc05b..44814a1a4 100644 --- a/docs/@vertx/redis-client/classes/redistransaction.html +++ b/docs/@vertx/redis/classes/redistransaction.html @@ -3,7 +3,7 @@ - RedisTransaction | @vertx/redis-client + RedisTransaction | @vertx/redis @@ -22,7 +22,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • The search index is not available
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - @vertx/redis-client + @vertx/redis
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -335,12 +335,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    append

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Append a value to a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Append a value to a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -371,17 +371,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -402,12 +405,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      auth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authenticate to the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authenticate to the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -432,17 +435,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -463,12 +469,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bgrewriteaof

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Asynchronously rewrite the append-only file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Asynchronously rewrite the append-only file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -484,17 +490,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -515,12 +524,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bgsave

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Asynchronously save the dataset to disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Asynchronously save the dataset to disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -536,17 +545,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -567,12 +579,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bitcount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Count set bits in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Count set bits in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -597,17 +609,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -628,12 +643,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bitcountRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Count set bits in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Count set bits in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -670,17 +685,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -701,12 +719,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                bitop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Perform bitwise operations between strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Perform bitwise operations between strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -743,17 +761,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -774,12 +795,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bitpos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Find first bit set or clear in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Find first bit set or clear in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -810,17 +831,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -841,12 +865,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bitposFrom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Find first bit set or clear in a string +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Find first bit set or clear in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also bitposRange() method, which takes start, and stop offset.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -885,17 +909,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -916,12 +943,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bitposRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Find first bit set or clear in a string +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Find first bit set or clear in a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Note: when both start, and stop offsets are specified, behaviour is slightly different than if only start is specified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -967,17 +994,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -998,12 +1028,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        blpop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Remove and get the first element in a list, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Remove and get the first element in a list, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -1034,17 +1064,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -1065,12 +1098,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          blpopMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Remove and get the first element in any of the lists, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Remove and get the first element in any of the lists, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -1101,17 +1134,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -1132,12 +1168,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            brpop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove and get the last element in a list, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove and get the last element in a list, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -1168,17 +1204,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -1199,12 +1238,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              brpopMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove and get the last element in any of the lists, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove and get the last element in any of the lists, or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -1235,17 +1274,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -1266,12 +1308,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                brpoplpush

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pop a value from a list, push it to another list and return it; or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pop a value from a list, push it to another list and return it; or block until one is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -1308,17 +1350,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -1339,12 +1384,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientGetname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the current connection name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the current connection name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -1360,17 +1405,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -1391,12 +1439,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientKill

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Kill the connection of a client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Kill the connection of a client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -1421,17 +1469,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -1452,12 +1503,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the list of client connections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the list of client connections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -1473,17 +1524,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -1504,12 +1558,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientPause

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stop processing commands from clients for some time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stop processing commands from clients for some time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -1534,17 +1588,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -1565,12 +1622,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientSetname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the current connection name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the current connection name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -1595,17 +1652,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -1626,12 +1686,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            close

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Close the client - when it is fully closed the handler will be called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Close the client - when it is fully closed the handler will be called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -1643,17 +1703,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<void>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<void>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -1674,12 +1737,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clusterAddslots

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Assign new hash slots to receiving node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Assign new hash slots to receiving node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -1701,17 +1764,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -1732,12 +1798,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clusterCountFailureReports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the number of failure reports active for a given node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the number of failure reports active for a given node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -1759,17 +1825,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -1790,12 +1859,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clusterCountkeysinslot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the number of local keys in the specified hash slot.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the number of local keys in the specified hash slot.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -1817,17 +1886,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -1848,12 +1920,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clusterDelslots

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set hash slots as unbound in receiving node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set hash slots as unbound in receiving node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -1875,17 +1947,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -1906,12 +1981,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clusterDelslotsMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set hash slots as unbound in receiving node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set hash slots as unbound in receiving node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -1933,17 +2008,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -1964,12 +2042,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clusterFailOverWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Forces a slave to perform a manual failover of its master.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Forces a slave to perform a manual failover of its master.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -1991,17 +2069,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -2022,12 +2103,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clusterFailover

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Forces a slave to perform a manual failover of its master.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Forces a slave to perform a manual failover of its master.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -2046,17 +2127,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -2077,12 +2161,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clusterForget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove a node from the nodes table.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove a node from the nodes table.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -2104,17 +2188,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -2135,12 +2222,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clusterGetkeysinslot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return local key names in the specified hash slot.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return local key names in the specified hash slot.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -2165,17 +2252,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -2196,12 +2286,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clusterInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provides info about Redis Cluster node state.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provides info about Redis Cluster node state.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -2220,17 +2310,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -2251,12 +2344,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clusterKeyslot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the hash slot of the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the hash slot of the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -2278,17 +2371,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -2309,12 +2405,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clusterMeet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Force a node cluster to handshake with another node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Force a node cluster to handshake with another node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -2339,17 +2435,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -2370,12 +2469,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clusterNodes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get Cluster config for the node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get Cluster config for the node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -2394,17 +2493,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -2425,12 +2527,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clusterReplicate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reconfigure a node as a slave of the specified master node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reconfigure a node as a slave of the specified master node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -2452,17 +2554,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -2483,12 +2588,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clusterReset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Reset a Redis Cluster node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Reset a Redis Cluster node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -2507,17 +2612,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -2538,12 +2646,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clusterResetWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reset a Redis Cluster node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reset a Redis Cluster node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -2565,17 +2673,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -2596,12 +2707,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clusterSaveconfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Forces the node to save cluster state on disk.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Forces the node to save cluster state on disk.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -2620,17 +2731,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -2651,12 +2765,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clusterSetConfigEpoch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the configuration epoch in a new node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the configuration epoch in a new node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -2678,17 +2792,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -2709,12 +2826,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clusterSetslot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Bind an hash slot to a specific node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Bind an hash slot to a specific node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -2739,17 +2856,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -2770,12 +2890,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clusterSetslotWithNode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Bind an hash slot to a specific node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Bind an hash slot to a specific node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -2803,17 +2923,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -2834,12 +2957,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clusterSlaves

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List slave nodes of the specified master node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List slave nodes of the specified master node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -2861,17 +2984,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -2892,12 +3018,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clusterSlots

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get array of Cluster slot to node mappings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get array of Cluster slot to node mappings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -2913,17 +3039,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -2944,12 +3073,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get array of Redis command details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get array of Redis command details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -2965,17 +3094,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -2996,12 +3128,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            commandCount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get total number of Redis commands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get total number of Redis commands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -3017,17 +3149,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -3048,12 +3183,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              commandGetkeys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Extract keys given a full Redis command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Extract keys given a full Redis command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -3069,17 +3204,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -3100,12 +3238,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                commandInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get array of specific Redis command details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get array of specific Redis command details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -3130,17 +3268,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -3161,12 +3302,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  configGet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the value of a configuration parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the value of a configuration parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -3191,17 +3332,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -3222,12 +3366,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    configResetstat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Reset the stats returned by INFO

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Reset the stats returned by INFO

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -3243,17 +3387,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -3274,12 +3421,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      configRewrite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Rewrite the configuration file with the in memory configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Rewrite the configuration file with the in memory configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -3295,17 +3442,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -3326,12 +3476,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        configSet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set a configuration parameter to the given value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set a configuration parameter to the given value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -3362,17 +3512,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -3393,12 +3546,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dbsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return the number of keys in the selected database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return the number of keys in the selected database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -3414,17 +3567,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -3445,12 +3601,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            debugObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get debugging information about a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get debugging information about a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -3475,17 +3631,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -3506,12 +3665,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              debugSegfault

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Make the server crash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Make the server crash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -3527,17 +3686,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -3558,12 +3720,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Decrement the integer value of a key by one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Decrement the integer value of a key by one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -3588,17 +3750,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -3619,12 +3784,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  decrby

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Decrement the integer value of a key by the given number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Decrement the integer value of a key by the given number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -3655,17 +3820,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -3686,12 +3854,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    del

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -3716,17 +3884,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -3747,12 +3918,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      delMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete many keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete many keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -3777,17 +3948,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -3808,12 +3982,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        discard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Discard all commands issued after MULTI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Discard all commands issued after MULTI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -3829,17 +4003,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -3860,12 +4037,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dump

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a serialized version of the value stored at the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a serialized version of the value stored at the specified key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -3890,17 +4067,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -3921,12 +4101,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            echo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Echo the given string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Echo the given string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -3951,17 +4131,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -3982,12 +4165,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eval

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned for This reason and to ensure type safety the reply is always guaranteed to be a JsonArray.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              When a reply if for example a String the handler will be called with a JsonArray with a single element containing @@ -4028,17 +4211,20 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -4059,12 +4245,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                evalsha

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned for This reason and to ensure type safety the reply is always guaranteed to be a JsonArray.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When a reply if for example a String the handler will be called with a JsonArray with a single element containing @@ -4105,17 +4291,20 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -4136,12 +4325,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Execute all commands issued after MULTI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Execute all commands issued after MULTI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -4157,17 +4346,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -4188,12 +4380,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Determine if a key exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Determine if a key exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -4218,17 +4410,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -4249,12 +4444,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      existsMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determine if one or many keys exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determine if one or many keys exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -4279,17 +4474,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -4310,12 +4508,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expire

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set a key's time to live in seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set a key's time to live in seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -4346,17 +4544,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -4377,12 +4578,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expireat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the expiration for a key as a UNIX timestamp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the expiration for a key as a UNIX timestamp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -4413,17 +4614,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -4444,12 +4648,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flushall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove all keys from all databases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove all keys from all databases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -4465,17 +4669,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -4496,12 +4703,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              flushdb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove all keys from the current database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove all keys from the current database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -4517,17 +4724,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -4548,12 +4758,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                geoadd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -4596,17 +4806,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -4627,12 +4840,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  geoaddMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add one or more geospatial items in the geospatial index represented using a sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -4663,17 +4876,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -4694,12 +4910,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    geodist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -4736,17 +4952,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -4767,12 +4986,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      geodistWithUnit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return the distance between two members in the geospatial index represented by the sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -4815,17 +5034,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -4846,12 +5068,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        geohash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return valid Geohash strings representing the position of one or more elements in a sorted set value representing +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -4883,17 +5105,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -4914,12 +5139,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          geohashMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return valid Geohash strings representing the position of one or more elements in a sorted set value representing +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -4951,17 +5176,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -4982,12 +5210,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            geopos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -5019,17 +5247,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -5050,12 +5281,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              geoposMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -5087,17 +5318,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -5118,12 +5352,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                georadius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -5173,17 +5407,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -5204,12 +5441,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  georadiusWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -5265,17 +5502,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -5296,12 +5536,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    georadiusbymember

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -5346,17 +5586,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -5377,12 +5620,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      georadiusbymemberWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -5433,17 +5676,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -5464,12 +5710,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -5494,17 +5740,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -5525,12 +5774,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getBinary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get the value of a key - without decoding as utf-8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get the value of a key - without decoding as utf-8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -5555,17 +5804,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<Buffer>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<Buffer>): void | Handler<AsyncResult<Buffer>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<Buffer>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<Buffer>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<Buffer>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -5586,12 +5838,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getbit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the bit value at offset in the string value stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the bit value at offset in the string value stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -5622,17 +5874,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -5653,12 +5908,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get a substring of the string stored at a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get a substring of the string stored at a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -5695,17 +5950,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -5726,12 +5984,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the string value of a key and return its old value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the string value of a key and return its old value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -5762,17 +6020,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -5793,12 +6054,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hdel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete one or more hash fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete one or more hash fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -5829,17 +6090,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -5860,12 +6124,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hdelMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete one or more hash fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete one or more hash fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -5896,17 +6160,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -5927,12 +6194,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hexists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determine if a hash field exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determine if a hash field exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -5963,17 +6230,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -5994,12 +6264,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the value of a hash field

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the value of a hash field

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -6030,17 +6300,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -6061,12 +6334,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hgetall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get all the fields and values in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get all the fields and values in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -6091,17 +6364,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -6122,12 +6398,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hincrby

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Increment the integer value of a hash field by the given number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Increment the integer value of a hash field by the given number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -6164,17 +6440,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -6195,12 +6474,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hincrbyfloat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Increment the float value of a hash field by the given amount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Increment the float value of a hash field by the given amount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -6237,17 +6516,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -6268,12 +6550,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                hkeys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all the fields in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all the fields in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -6298,17 +6580,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -6329,12 +6614,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hlen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the number of fields in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the number of fields in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -6359,17 +6644,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -6390,12 +6678,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hmget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the values of all the given hash fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the values of all the given hash fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -6426,17 +6714,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -6457,12 +6748,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hmset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set multiple hash fields to multiple values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set multiple hash fields to multiple values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -6484,6 +6775,11 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      values: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of field:value pairs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -6493,17 +6789,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -6524,12 +6823,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hscan

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Incrementally iterate hash fields and associated values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Incrementally iterate hash fields and associated values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -6566,17 +6865,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -6597,12 +6899,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the string value of a hash field

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the string value of a hash field

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -6639,17 +6941,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -6670,12 +6975,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hsetnx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the value of a hash field, only if the field does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the value of a hash field, only if the field does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -6712,17 +7017,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -6743,12 +7051,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hvals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get all the values in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get all the values in a hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -6773,17 +7081,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -6804,12 +7115,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                incr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Increment the integer value of a key by one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Increment the integer value of a key by one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -6834,17 +7145,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -6865,12 +7179,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  incrby

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Increment the integer value of a key by the given amount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Increment the integer value of a key by the given amount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -6901,17 +7215,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -6932,12 +7249,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    incrbyfloat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Increment the float value of a key by the given amount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Increment the float value of a key by the given amount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -6968,17 +7285,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -6999,12 +7319,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get information and statistics about the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get information and statistics about the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -7023,17 +7343,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -7054,12 +7377,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        infoSection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get information and statistics about the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get information and statistics about the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -7084,17 +7407,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -7115,12 +7441,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Find all keys matching the given pattern

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Find all keys matching the given pattern

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -7145,17 +7471,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -7176,12 +7505,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastsave

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get the UNIX time stamp of the last successful save to disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get the UNIX time stamp of the last successful save to disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -7197,17 +7526,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -7228,12 +7560,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lindex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get an element from a list by its index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get an element from a list by its index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -7264,17 +7596,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -7295,12 +7630,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                linsert

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Insert an element before or after another element in a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Insert an element before or after another element in a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -7343,17 +7678,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -7374,12 +7712,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  llen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the length of a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the length of a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -7404,17 +7742,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -7435,12 +7776,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lpop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove and get the first element in a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove and get the first element in a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -7465,17 +7806,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -7496,12 +7840,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lpush

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Prepend one value to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Prepend one value to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -7532,17 +7876,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -7563,12 +7910,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lpushMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Prepend one or multiple values to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Prepend one or multiple values to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -7599,17 +7946,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -7630,12 +7980,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          lpushx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Prepend a value to a list, only if the list exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Prepend a value to a list, only if the list exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -7666,17 +8016,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -7697,12 +8050,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get a range of elements from a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get a range of elements from a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -7739,17 +8092,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -7770,12 +8126,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lrem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove elements from a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove elements from a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -7812,17 +8168,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -7843,12 +8202,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the value of an element in a list by its index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the value of an element in a list by its index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -7885,17 +8244,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -7916,12 +8278,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ltrim

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Trim a list to the specified range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Trim a list to the specified range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -7958,17 +8320,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -7989,12 +8354,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the value of the given key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the value of the given key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -8019,17 +8384,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -8050,12 +8418,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mgetMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the values of all the given keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the values of all the given keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -8080,17 +8448,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -8111,12 +8482,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        migrate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Atomically transfer a key from a Redis instance to another one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Atomically transfer a key from a Redis instance to another one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -8168,17 +8539,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -8199,12 +8573,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          monitor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Listen for all requests received by the server in real time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Listen for all requests received by the server in real time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -8220,17 +8594,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -8251,12 +8628,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            move

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Move a key to another database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Move a key to another database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -8287,17 +8664,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -8318,12 +8698,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set multiple keys to multiple values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set multiple keys to multiple values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -8339,6 +8719,11 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keyvals: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Key value pairs to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -8348,17 +8733,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -8379,12 +8767,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                msetnx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set multiple keys to multiple values, only if none of the keys exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set multiple keys to multiple values, only if none of the keys exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -8400,6 +8788,11 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keyvals: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Key value pairs to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -8409,17 +8802,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -8440,12 +8836,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  multi

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Mark the start of a RedisTransaction block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Mark the start of a RedisTransaction block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -8461,17 +8857,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -8492,12 +8891,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inspect the internals of Redis objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inspect the internals of Redis objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -8528,17 +8927,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -8559,12 +8961,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      persist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove the expiration from a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove the expiration from a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -8589,17 +8991,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -8620,12 +9025,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pexpire

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set a key's time to live in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set a key's time to live in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -8656,17 +9061,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -8687,12 +9095,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pexpireat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the expiration for a key as a UNIX timestamp specified in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the expiration for a key as a UNIX timestamp specified in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -8723,17 +9131,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -8754,12 +9165,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            pfadd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds the specified element to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds the specified element to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -8790,17 +9201,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -8821,12 +9235,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pfaddMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Adds the specified elements to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Adds the specified elements to the specified HyperLogLog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -8857,17 +9271,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -8888,12 +9305,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pfcount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the approximated cardinality of the set observed by the HyperLogLog at key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the approximated cardinality of the set observed by the HyperLogLog at key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -8918,17 +9335,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -8949,12 +9369,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pfcountMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -8979,17 +9399,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -9010,12 +9433,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pfmerge

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Merge N different HyperLogLogs into a single one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Merge N different HyperLogLogs into a single one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -9046,17 +9469,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -9077,12 +9503,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Ping the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Ping the server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -9098,17 +9524,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -9129,12 +9558,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        psetex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the value and expiration in milliseconds of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the value and expiration in milliseconds of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -9171,17 +9600,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -9202,12 +9634,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          psubscribe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Listen for messages published to channels matching the given pattern

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Listen for messages published to channels matching the given pattern

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -9232,17 +9664,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -9263,12 +9698,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            psubscribeMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Listen for messages published to channels matching the given patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Listen for messages published to channels matching the given patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -9293,17 +9728,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -9324,12 +9762,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pttl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the time to live for a key in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the time to live for a key in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -9354,17 +9792,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -9385,12 +9826,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                publish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Post a message to a channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Post a message to a channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -9421,17 +9862,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -9452,12 +9896,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pubsubChannels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Lists the currently active channels - only those matching the pattern

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Lists the currently active channels - only those matching the pattern

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -9482,17 +9926,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -9513,12 +9960,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pubsubNumpat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -9537,17 +9984,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -9568,12 +10018,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pubsubNumsub

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -9598,17 +10048,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -9629,12 +10082,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        punsubscribe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stop listening for messages posted to channels matching the given patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stop listening for messages posted to channels matching the given patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -9659,17 +10112,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -9690,12 +10146,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          randomkey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a random key from the keyspace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a random key from the keyspace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -9711,17 +10167,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -9742,12 +10201,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rename a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rename a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -9778,17 +10237,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -9809,12 +10271,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              renamenx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Rename a key, only if the new key does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Rename a key, only if the new key does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -9845,17 +10307,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -9876,12 +10341,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                restore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a key using the provided serialized value, previously obtained using DUMP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a key using the provided serialized value, previously obtained using DUMP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -9918,17 +10383,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -9949,12 +10417,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  role

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the role of the instance in the context of replication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the role of the instance in the context of replication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -9970,17 +10438,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -10001,12 +10472,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rpop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove and get the last element in a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove and get the last element in a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -10031,17 +10502,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -10062,12 +10536,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rpoplpush

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove the last element in a list, append it to another list and return it

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove the last element in a list, append it to another list and return it

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -10098,17 +10572,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -10129,12 +10606,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rpush

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -10165,17 +10642,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -10196,12 +10676,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rpushMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Append one or multiple values to a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -10232,17 +10712,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -10263,12 +10746,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rpushx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Append a value to a list, only if the list exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Append a value to a list, only if the list exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -10299,17 +10782,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -10330,12 +10816,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sadd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Add a member to a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Add a member to a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -10366,17 +10852,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -10397,12 +10886,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                saddMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add one or more members to a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add one or more members to a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -10433,17 +10922,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -10464,12 +10956,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Synchronously save the dataset to disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Synchronously save the dataset to disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -10485,17 +10977,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -10516,12 +11011,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scan

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Incrementally iterate the keys space

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Incrementally iterate the keys space

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -10552,17 +11047,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -10583,12 +11081,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the number of members in a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the number of members in a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -10613,17 +11111,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -10644,12 +11145,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scriptExists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check existence of script in the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check existence of script in the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -10674,17 +11175,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -10705,12 +11209,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scriptExistsMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check existence of scripts in the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check existence of scripts in the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -10735,17 +11239,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -10766,12 +11273,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scriptFlush

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove all the scripts from the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove all the scripts from the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -10787,17 +11294,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -10818,12 +11328,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scriptKill

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Kill the script currently in execution.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Kill the script currently in execution.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -10839,17 +11349,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -10870,12 +11383,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scriptLoad

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Load the specified Lua script into the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Load the specified Lua script into the script cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -10900,17 +11413,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -10931,12 +11447,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sdiff

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Subtract multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Subtract multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -10967,17 +11483,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -10998,12 +11517,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sdiffstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Subtract multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Subtract multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -11040,17 +11559,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -11071,12 +11593,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      select

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Change the selected database for the current connection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Change the selected database for the current connection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -11101,17 +11623,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -11132,12 +11657,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -11168,17 +11693,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -11199,12 +11727,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setBinary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the binary string value of a key - without encoding as utf-8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the binary string value of a key - without encoding as utf-8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -11235,17 +11763,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -11266,12 +11797,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setBinaryWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -11308,17 +11839,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -11339,12 +11873,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the string value of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -11381,17 +11915,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -11412,12 +11949,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setbit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets or clears the bit at offset in the string value stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets or clears the bit at offset in the string value stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -11454,17 +11991,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -11485,12 +12025,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the value and expiration of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the value and expiration of a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -11527,17 +12067,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -11558,12 +12101,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setnx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the value of a key, only if the key does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the value of a key, only if the key does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -11594,17 +12137,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -11625,12 +12171,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overwrite part of a string at key starting at the specified offset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overwrite part of a string at key starting at the specified offset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -11667,17 +12213,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -11698,12 +12247,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sinter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Intersect multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Intersect multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -11728,17 +12277,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -11759,12 +12311,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sinterstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Intersect multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Intersect multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -11795,17 +12347,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -11826,12 +12381,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sismember

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Determine if a given value is a member of a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Determine if a given value is a member of a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -11862,17 +12417,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -11893,12 +12451,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              slaveof

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Make the server a slave of another instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Make the server a slave of another instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -11929,17 +12487,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -11960,12 +12521,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                slaveofNoone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Make this server a master

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Make this server a master

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -11984,17 +12545,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -12015,12 +12579,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  slowlogGet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Read the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Read the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -12045,17 +12609,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -12076,12 +12643,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    slowlogLen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the length of the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the length of the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -12100,17 +12667,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -12131,12 +12701,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      slowlogReset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Reset the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Reset the Redis slow queries log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -12155,17 +12725,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -12186,12 +12759,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        smembers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get all the members in a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get all the members in a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -12216,17 +12789,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<any[]>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<any[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<any[]>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -12247,12 +12823,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          smove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Move a member from one set to another

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Move a member from one set to another

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -12289,17 +12865,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -12320,12 +12899,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sort the elements in a list, set or sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sort the elements in a list, set or sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -12356,17 +12935,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -12387,12 +12969,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              spop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove and return a random member from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove and return a random member from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -12417,17 +12999,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -12448,12 +13033,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                spopMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove and return random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove and return random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -12484,17 +13069,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -12515,12 +13103,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  srandmember

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -12545,17 +13133,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -12576,12 +13167,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    srandmemberCount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get one or multiple random members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -12612,17 +13203,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -12643,12 +13237,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      srem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove one member from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove one member from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -12679,17 +13273,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -12710,12 +13307,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sremMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Remove one or more members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Remove one or more members from a set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -12746,17 +13343,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -12777,12 +13377,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sscan

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Incrementally iterate Set elements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Incrementally iterate Set elements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -12819,17 +13419,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -12850,12 +13453,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            strlen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get the length of the value stored in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get the length of the value stored in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -12880,17 +13483,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -12911,12 +13517,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subscribe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -12941,17 +13547,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -12972,12 +13581,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                subscribeMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Listen for messages published to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -13002,17 +13611,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -13033,12 +13645,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sunion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add multiple sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -13063,17 +13675,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -13094,12 +13709,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sunionstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add multiple sets and store the resulting set in a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -13130,17 +13745,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -13161,12 +13779,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      swapdb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Swaps two Redis databases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Swaps two Redis databases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -13197,17 +13815,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -13228,12 +13849,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sync

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Internal command used for replication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Internal command used for replication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -13249,17 +13870,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -13280,12 +13904,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return the current server time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return the current server time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -13301,17 +13925,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -13332,12 +13959,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ttl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get the time to live for a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get the time to live for a key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -13362,17 +13989,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -13393,12 +14023,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Determine the type stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Determine the type stored at key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -13423,17 +14053,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -13454,12 +14087,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                unlink

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -13481,17 +14114,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -13512,12 +14148,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  unlinkMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete multiple keys asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete multiple keys asynchronously in another thread. Otherwise it is just as DEL, but non blocking.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -13542,17 +14178,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -13573,12 +14212,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unsubscribe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Stop listening for messages posted to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Stop listening for messages posted to the given channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -13603,17 +14242,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -13634,12 +14276,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      unwatch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Forget about all watched keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Forget about all watched keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -13655,17 +14297,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -13686,12 +14331,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        wait

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Wait for the synchronous replication of all the write commands sent in the context of the current connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Wait for the synchronous replication of all the write commands sent in the context of the current connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -13716,17 +14361,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -13747,12 +14395,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          watch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Watch the given keys to determine execution of the MULTI/EXEC block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Watch the given keys to determine execution of the MULTI/EXEC block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -13777,17 +14425,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -13808,12 +14459,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            watchMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Watch the given keys to determine execution of the MULTI/EXEC block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Watch the given keys to determine execution of the MULTI/EXEC block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -13838,17 +14489,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -13869,12 +14523,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zadd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -13911,17 +14565,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -13936,18 +14593,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zaddMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • zaddMany(key: string, members: Map<String, number>, handler: function): RedisTransaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • zaddMany(key: string, members: object, handler: function): RedisTransaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add one or more members to a sorted set, or update its score if it already exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -13965,10 +14622,15 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  members: Map<String, number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  members: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  New member keys and their scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [key: string]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -13978,17 +14640,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -14009,12 +14674,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zcard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the number of members in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the number of members in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -14039,17 +14704,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -14070,12 +14738,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zcount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Count the members in a sorted set with scores within the given values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Count the members in a sorted set with scores within the given values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -14112,17 +14780,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -14143,12 +14814,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zincrby

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Increment the score of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Increment the score of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -14185,17 +14856,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -14216,12 +14890,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zinterstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Intersect multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Intersect multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -14258,17 +14932,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -14283,18 +14960,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zinterstoreWeighed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Intersect multiple sorted sets and store the resulting sorted set in a new key using weights for scoring

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Intersect multiple sorted sets and store the resulting sorted set in a new key using weights for scoring

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -14312,10 +14989,15 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              destkey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sets: Map<String, number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sets: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of keys identifying sorted sets to intersect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • options: AggregateOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -14331,17 +15013,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -14362,12 +15047,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zlexcount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Count the number of members in a sorted set between a given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Count the number of members in a sorted set between a given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -14404,17 +15089,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -14435,12 +15123,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -14477,17 +15165,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -14508,12 +15199,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zrangeWithOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return a range of members in a sorted set, by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -14556,17 +15247,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -14587,12 +15281,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zrangebylex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a range of members in a sorted set, by lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a range of members in a sorted set, by lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -14635,17 +15329,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -14666,12 +15363,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zrangebyscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a range of members in a sorted set, by score

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a range of members in a sorted set, by score

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -14714,17 +15411,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -14745,12 +15445,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zrank

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Determine the index of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Determine the index of a member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -14781,17 +15481,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -14812,12 +15515,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zrem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove one member from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove one member from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -14848,17 +15551,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -14879,12 +15585,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zremMany

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove one or more members from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove one or more members from a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -14915,17 +15621,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -14946,12 +15655,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zremrangebylex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove all members in a sorted set between the given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove all members in a sorted set between the given lexicographical range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -14988,17 +15697,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -15019,12 +15731,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zremrangebyrank

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Remove all members in a sorted set within the given indexes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Remove all members in a sorted set within the given indexes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -15061,17 +15773,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -15092,12 +15807,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zremrangebyscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove all members in a sorted set within the given scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove all members in a sorted set within the given scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -15131,17 +15846,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -15162,12 +15880,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zrevrange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a range of members in a sorted set, by index, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a range of members in a sorted set, by index, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -15210,17 +15928,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -15241,12 +15962,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zrevrangebylex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a range of members in a sorted set, by score, between the given lexicographical range with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a range of members in a sorted set, by score, between the given lexicographical range with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -15289,17 +16010,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -15320,12 +16044,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zrevrangebyscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a range of members in a sorted set, by score, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a range of members in a sorted set, by score, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -15368,17 +16092,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -15399,12 +16126,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zrevrank

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Determine the index of a member in a sorted set, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Determine the index of a member in a sorted set, with scores ordered from high to low

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -15435,17 +16162,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -15466,12 +16196,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zscan

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Incrementally iterate sorted sets elements and associated scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Incrementally iterate sorted sets elements and associated scores

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -15508,17 +16238,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -15539,12 +16272,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zscore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the score associated with the given member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the score associated with the given member in a sorted set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -15575,17 +16308,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -15606,12 +16342,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zunionstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add multiple sorted sets and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -15648,17 +16384,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -15673,18 +16412,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zunionstoreWeighed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add multiple sorted sets using weights, and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add multiple sorted sets using weights, and store the resulting sorted set in a new key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -15702,10 +16441,15 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sets: Map<String, number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sets: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Map containing set-key:weight pairs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [key: string]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • options: AggregateOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -15721,17 +16465,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      handler: function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (result: AsyncResult<string>): void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (res: AsyncResult<string>): void | Handler<AsyncResult<string>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            result: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            res: AsyncResult<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void + | + Handler<AsyncResult<string>> +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • diff --git a/docs/@vertx/redis-client/classes/georadiusoptions.html b/docs/@vertx/redis/classes/scanoptions.html similarity index 61% rename from docs/@vertx/redis-client/classes/georadiusoptions.html rename to docs/@vertx/redis/classes/scanoptions.html index ca15a39e5..d1d268de2 100644 --- a/docs/@vertx/redis-client/classes/georadiusoptions.html +++ b/docs/@vertx/redis/classes/scanoptions.html @@ -3,7 +3,7 @@ - GeoRadiusOptions | @vertx/redis-client + ScanOptions | @vertx/redis @@ -22,7 +22,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • The search index is not available
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      - @vertx/redis-client + @vertx/redis
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -54,10 +54,10 @@ Globals
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • - GeoRadiusOptions + ScanOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class GeoRadiusOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class ScanOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -68,7 +68,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class GeoRadiusOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • - GeoRadiusOptions + ScanOptions
    • @@ -77,110 +77,139 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns ScanOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns ScanOptions

      +
      • +
    +
    +
    +
    +

    Methods

    +

    count

    -
    count: number
    - -
    -
    -

    Set the radius options limit the result count.

    -
    -
    -
    param
    -

    the count

    -
    -
    returns
    -

    self

    -
    -
    -
    +
      +
    • count(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    withCoord

    -
    withCoord: boolean
    - -
    -
    -

    Set the radius options to be coordinate based.

    -
    -
    -
    param
    -

    true for coordinate base

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    match

    +
      +
    • match(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    withDist

    -
    withDist: boolean
    - -
    -
    -

    Set the radius options to be distance based.

    -
    -
    -
    param
    -

    true for distance base

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setCount

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        count: number
        +
        • +
      +

      Returns ScanOptions

      +
      • +
    -
    - -

    withHash

    -
    withHash: boolean
    - -
    -
    -

    Set the radius options to be hash based.

    -
    -
    -
    param
    -

    true for hash base

    -
    -
    returns
    -

    self

    -
    -
    -
    +
    + +

    setMatch

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        match: string
        +
        • +
      +

      Returns ScanOptions

      +
      • +
    @@ -248,27 +277,9 @@

    withHash

  • GeoMember
    • - - - + +
    • Script
      • diff --git a/docs/@vertx/redis-client/classes/script.html b/docs/@vertx/redis/classes/script.html similarity index 98% rename from docs/@vertx/redis-client/classes/script.html rename to docs/@vertx/redis/classes/script.html index ca2158b1c..3b878edc2 100644 --- a/docs/@vertx/redis-client/classes/script.html +++ b/docs/@vertx/redis/classes/script.html @@ -3,7 +3,7 @@ - Script | @vertx/redis-client + Script | @vertx/redis @@ -22,7 +22,7 @@
    • Preparing search index...
    • The search index is not available
    - @vertx/redis-client + @vertx/redis
    @@ -99,7 +99,7 @@

    getScript

  • Returns string

    @@ -116,7 +116,7 @@

    getSha1

  • Returns string

    @@ -134,7 +134,7 @@

    Static create

  • Parameters

    @@ -148,7 +148,7 @@

    Returns

    Parameters

    diff --git a/docs/@vertx/redis/classes/setoptions.html b/docs/@vertx/redis/classes/setoptions.html new file mode 100644 index 000000000..bedcc4a94 --- /dev/null +++ b/docs/@vertx/redis/classes/setoptions.html @@ -0,0 +1,507 @@ + + + + + + SetOptions | @vertx/redis + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class SetOptions

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + SetOptions +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns SetOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns SetOptions

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    ex

    +
      +
    • ex(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    nx

    +
      +
    • nx(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    px

    +
      +
    • px(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    setEX

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ex: number
        +
        • +
      +

      Returns SetOptions

      +
      • +
    +
    +
    + +

    setNX

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        nx: boolean
        +
        • +
      +

      Returns SetOptions

      +
      • +
    +
    +
    + +

    setPX

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        px: number
        +
        • +
      +

      Returns SetOptions

      +
      • +
    +
    +
    + +

    setXX

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        xx: boolean
        +
        • +
      +

      Returns SetOptions

      +
      • +
    +
    +
    + +

    xx

    +
      +
    • xx(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/redis/classes/sortoptions.html b/docs/@vertx/redis/classes/sortoptions.html new file mode 100644 index 000000000..4d7f186e7 --- /dev/null +++ b/docs/@vertx/redis/classes/sortoptions.html @@ -0,0 +1,555 @@ + + + + + + SortOptions | @vertx/redis + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class SortOptions

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + SortOptions +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns SortOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns SortOptions

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addGet

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        gets: string
        +
        • +
      +

      Returns SortOptions

      +
      • +
    +
    +
    + +

    alpha

    +
      +
    • alpha(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    by

    +
      +
    • by(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    descending

    +
      +
    • descending(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    gets

    +
      +
    • gets(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    setAlpha

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        alpha: boolean
        +
        • +
      +

      Returns SortOptions

      +
      • +
    +
    +
    + +

    setBy

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        by: string
        +
        • +
      +

      Returns SortOptions

      +
      • +
    +
    +
    + +

    setDescending

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        descending: boolean
        +
        • +
      +

      Returns SortOptions

      +
      • +
    +
    +
    + +

    setStore

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        store: string
        +
        • +
      +

      Returns SortOptions

      +
      • +
    +
    +
    + +

    store

    +
      +
    • store(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/redis-client/enums/aggregateoptions.html b/docs/@vertx/redis/enums/aggregateoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/aggregateoptions.html rename to docs/@vertx/redis/enums/aggregateoptions.html index da136c71e..8f0e1092c 100644 --- a/docs/@vertx/redis-client/enums/aggregateoptions.html +++ b/docs/@vertx/redis/enums/aggregateoptions.html @@ -3,7 +3,7 @@ - AggregateOptions | @vertx/redis-client + AggregateOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis

    • @@ -88,7 +88,7 @@

    MAX

    MAX:
    @@ -98,7 +98,7 @@

    MIN

    MIN:
    @@ -108,7 +108,7 @@

    NONE

    NONE:
    @@ -118,7 +118,7 @@

    SUM

    SUM:
    diff --git a/docs/@vertx/redis-client/enums/bitfieldoverflowoptions.html b/docs/@vertx/redis/enums/bitfieldoverflowoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/bitfieldoverflowoptions.html rename to docs/@vertx/redis/enums/bitfieldoverflowoptions.html index 7f0a497b0..b628093d6 100644 --- a/docs/@vertx/redis-client/enums/bitfieldoverflowoptions.html +++ b/docs/@vertx/redis/enums/bitfieldoverflowoptions.html @@ -3,7 +3,7 @@ - BitFieldOverflowOptions | @vertx/redis-client + BitFieldOverflowOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -87,7 +87,7 @@

    FAIL

    FAIL:
    @@ -97,7 +97,7 @@

    SAT

    SAT:
    @@ -107,7 +107,7 @@

    WRAP

    WRAP:
    diff --git a/docs/@vertx/redis-client/enums/bitoperation.html b/docs/@vertx/redis/enums/bitoperation.html similarity index 98% rename from docs/@vertx/redis-client/enums/bitoperation.html rename to docs/@vertx/redis/enums/bitoperation.html index 24aa15044..85f433adc 100644 --- a/docs/@vertx/redis-client/enums/bitoperation.html +++ b/docs/@vertx/redis/enums/bitoperation.html @@ -3,7 +3,7 @@ - BitOperation | @vertx/redis-client + BitOperation | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -88,7 +88,7 @@

    AND

    AND:
    @@ -98,7 +98,7 @@

    NOT

    NOT:
    @@ -108,7 +108,7 @@

    OR

    OR:
    @@ -118,7 +118,7 @@

    XOR

    XOR:
    diff --git a/docs/@vertx/redis-client/enums/clientreplyoptions.html b/docs/@vertx/redis/enums/clientreplyoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/clientreplyoptions.html rename to docs/@vertx/redis/enums/clientreplyoptions.html index af7c6c5c6..22dc013a8 100644 --- a/docs/@vertx/redis-client/enums/clientreplyoptions.html +++ b/docs/@vertx/redis/enums/clientreplyoptions.html @@ -3,7 +3,7 @@ - ClientReplyOptions | @vertx/redis-client + ClientReplyOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -87,7 +87,7 @@

    OFF

    OFF:
    @@ -97,7 +97,7 @@

    ON

    ON:
    @@ -107,7 +107,7 @@

    SKIP

    SKIP:
    diff --git a/docs/@vertx/redis-client/enums/failoveroptions.html b/docs/@vertx/redis/enums/failoveroptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/failoveroptions.html rename to docs/@vertx/redis/enums/failoveroptions.html index 7b66d13fe..1e65889c7 100644 --- a/docs/@vertx/redis-client/enums/failoveroptions.html +++ b/docs/@vertx/redis/enums/failoveroptions.html @@ -3,7 +3,7 @@ - FailoverOptions | @vertx/redis-client + FailoverOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -86,7 +86,7 @@

    FORCE

    FORCE:
    @@ -96,7 +96,7 @@

    TAKEOVER

    TAKEOVER:
    diff --git a/docs/@vertx/redis-client/enums/geounit.html b/docs/@vertx/redis/enums/geounit.html similarity index 98% rename from docs/@vertx/redis-client/enums/geounit.html rename to docs/@vertx/redis/enums/geounit.html index ac7d304da..504fe5d97 100644 --- a/docs/@vertx/redis-client/enums/geounit.html +++ b/docs/@vertx/redis/enums/geounit.html @@ -3,7 +3,7 @@ - GeoUnit | @vertx/redis-client + GeoUnit | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -88,7 +88,7 @@

    ft

    ft:
    @@ -98,7 +98,7 @@

    km

    km:
    @@ -108,7 +108,7 @@

    m

    m:
    @@ -118,7 +118,7 @@

    mi

    mi:
    diff --git a/docs/@vertx/redis-client/enums/insertoptions.html b/docs/@vertx/redis/enums/insertoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/insertoptions.html rename to docs/@vertx/redis/enums/insertoptions.html index 7e1aa6d35..d6efdf342 100644 --- a/docs/@vertx/redis-client/enums/insertoptions.html +++ b/docs/@vertx/redis/enums/insertoptions.html @@ -3,7 +3,7 @@ - InsertOptions | @vertx/redis-client + InsertOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -86,7 +86,7 @@

    AFTER

    AFTER:
    @@ -96,7 +96,7 @@

    BEFORE

    BEFORE:
    diff --git a/docs/@vertx/redis-client/enums/objectcmd.html b/docs/@vertx/redis/enums/objectcmd.html similarity index 98% rename from docs/@vertx/redis-client/enums/objectcmd.html rename to docs/@vertx/redis/enums/objectcmd.html index 2365f1ca8..25c8761ef 100644 --- a/docs/@vertx/redis-client/enums/objectcmd.html +++ b/docs/@vertx/redis/enums/objectcmd.html @@ -3,7 +3,7 @@ - ObjectCmd | @vertx/redis-client + ObjectCmd | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -87,7 +87,7 @@

    ENCODING

    ENCODING:
    @@ -97,7 +97,7 @@

    IDLETIME

    IDLETIME:
    @@ -107,7 +107,7 @@

    REFCOUNT

    REFCOUNT:
    diff --git a/docs/@vertx/redis-client/enums/rangeoptions.html b/docs/@vertx/redis/enums/rangeoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/rangeoptions.html rename to docs/@vertx/redis/enums/rangeoptions.html index 809cdf1e1..24464f1b4 100644 --- a/docs/@vertx/redis-client/enums/rangeoptions.html +++ b/docs/@vertx/redis/enums/rangeoptions.html @@ -3,7 +3,7 @@ - RangeOptions | @vertx/redis-client + RangeOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -86,7 +86,7 @@

    NONE

    NONE:
    @@ -96,7 +96,7 @@

    WITHSCORES

    WITHSCORES:
    diff --git a/docs/@vertx/redis-client/enums/resetoptions.html b/docs/@vertx/redis/enums/resetoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/resetoptions.html rename to docs/@vertx/redis/enums/resetoptions.html index bdc935dd1..6e27d341d 100644 --- a/docs/@vertx/redis-client/enums/resetoptions.html +++ b/docs/@vertx/redis/enums/resetoptions.html @@ -3,7 +3,7 @@ - ResetOptions | @vertx/redis-client + ResetOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -86,7 +86,7 @@

    HARD

    HARD:
    @@ -96,7 +96,7 @@

    SOFT

    SOFT:
    diff --git a/docs/@vertx/redis-client/enums/scriptdebugoptions.html b/docs/@vertx/redis/enums/scriptdebugoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/scriptdebugoptions.html rename to docs/@vertx/redis/enums/scriptdebugoptions.html index 3168053af..f4d95f560 100644 --- a/docs/@vertx/redis-client/enums/scriptdebugoptions.html +++ b/docs/@vertx/redis/enums/scriptdebugoptions.html @@ -3,7 +3,7 @@ - ScriptDebugOptions | @vertx/redis-client + ScriptDebugOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -87,7 +87,7 @@

    NO

    NO:
    @@ -97,7 +97,7 @@

    SYNC

    SYNC:
    @@ -107,7 +107,7 @@

    YES

    YES:
    diff --git a/docs/@vertx/redis-client/enums/shutdownoptions.html b/docs/@vertx/redis/enums/shutdownoptions.html similarity index 98% rename from docs/@vertx/redis-client/enums/shutdownoptions.html rename to docs/@vertx/redis/enums/shutdownoptions.html index 31f540dca..6af30555e 100644 --- a/docs/@vertx/redis-client/enums/shutdownoptions.html +++ b/docs/@vertx/redis/enums/shutdownoptions.html @@ -3,7 +3,7 @@ - ShutdownOptions | @vertx/redis-client + ShutdownOptions | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -87,7 +87,7 @@

    NONE

    NONE:
    @@ -97,7 +97,7 @@

    NOSAVE

    NOSAVE:
    @@ -107,7 +107,7 @@

    SAVE

    SAVE:
    diff --git a/docs/@vertx/redis-client/enums/slotcmd.html b/docs/@vertx/redis/enums/slotcmd.html similarity index 98% rename from docs/@vertx/redis-client/enums/slotcmd.html rename to docs/@vertx/redis/enums/slotcmd.html index 2ea131394..1f9be6c5d 100644 --- a/docs/@vertx/redis-client/enums/slotcmd.html +++ b/docs/@vertx/redis/enums/slotcmd.html @@ -3,7 +3,7 @@ - SlotCmd | @vertx/redis-client + SlotCmd | @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -88,7 +88,7 @@

    IMPORTING

    IMPORTING:
    @@ -98,7 +98,7 @@

    MIGRATING

    MIGRATING:
    @@ -108,7 +108,7 @@

    NODE

    NODE:
    @@ -118,7 +118,7 @@

    STABLE

    STABLE:
    diff --git a/docs/@vertx/redis-client/globals.html b/docs/@vertx/redis/globals.html similarity index 99% rename from docs/@vertx/redis-client/globals.html rename to docs/@vertx/redis/globals.html index 03c777606..28f5accc4 100644 --- a/docs/@vertx/redis-client/globals.html +++ b/docs/@vertx/redis/globals.html @@ -3,7 +3,7 @@ - @vertx/redis-client + @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -54,7 +54,7 @@ Globals -

    @vertx/redis-client

    +

    @vertx/redis

    diff --git a/docs/@vertx/redis-client/index.html b/docs/@vertx/redis/index.html similarity index 99% rename from docs/@vertx/redis-client/index.html rename to docs/@vertx/redis/index.html index dec7b5836..5a3bf6c0c 100644 --- a/docs/@vertx/redis-client/index.html +++ b/docs/@vertx/redis/index.html @@ -3,7 +3,7 @@ - @vertx/redis-client + @vertx/redis @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/redis-client + @vertx/redis
    @@ -54,7 +54,7 @@ Globals -

    @vertx/redis-client

    +

    @vertx/redis

    diff --git a/docs/@vertx/service-discovery-backend-consul/index.html b/docs/@vertx/service-discovery-backend-consul/index.html index 0a2ca928c..daceeaf13 100644 --- a/docs/@vertx/service-discovery-backend-consul/index.html +++ b/docs/@vertx/service-discovery-backend-consul/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-backend-consul

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-backend-consul');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-backend-consul/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-backend-consul/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-backend-redis/index.html b/docs/@vertx/service-discovery-backend-redis/index.html index debd39ad2..eecd2326f 100644 --- a/docs/@vertx/service-discovery-backend-redis/index.html +++ b/docs/@vertx/service-discovery-backend-redis/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-backend-redis

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-backend-redis');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-backend-redis/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-backend-redis/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-backend-zookeeper/index.html b/docs/@vertx/service-discovery-backend-zookeeper/index.html index 07d59eb43..36cbebb1c 100644 --- a/docs/@vertx/service-discovery-backend-zookeeper/index.html +++ b/docs/@vertx/service-discovery-backend-zookeeper/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-backend-zookeeper

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-backend-zookeeper');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-backend-zookeeper/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-backend-zookeeper/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-bridge-consul/index.html b/docs/@vertx/service-discovery-bridge-consul/index.html index e3aeea740..40d86694a 100644 --- a/docs/@vertx/service-discovery-bridge-consul/index.html +++ b/docs/@vertx/service-discovery-bridge-consul/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-bridge-consul

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-consul');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-consul/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-consul/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-bridge-docker-links/index.html b/docs/@vertx/service-discovery-bridge-docker-links/index.html index 2c1bdb5a9..f8875ac5a 100644 --- a/docs/@vertx/service-discovery-bridge-docker-links/index.html +++ b/docs/@vertx/service-discovery-bridge-docker-links/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-bridge-docker-links

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-docker-links');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-docker-links/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-docker-links/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-bridge-docker/index.html b/docs/@vertx/service-discovery-bridge-docker/index.html index de1d212f5..28cdfe63f 100644 --- a/docs/@vertx/service-discovery-bridge-docker/index.html +++ b/docs/@vertx/service-discovery-bridge-docker/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-bridge-docker

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-docker');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-docker/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-docker/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-bridge-kubernetes/index.html b/docs/@vertx/service-discovery-bridge-kubernetes/index.html index c1f7dc510..0c5ed7028 100644 --- a/docs/@vertx/service-discovery-bridge-kubernetes/index.html +++ b/docs/@vertx/service-discovery-bridge-kubernetes/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-bridge-kubernetes

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-kubernetes');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-kubernetes/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-kubernetes/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery-bridge-zookeeper/index.html b/docs/@vertx/service-discovery-bridge-zookeeper/index.html index 586cc721d..d5e9b0870 100644 --- a/docs/@vertx/service-discovery-bridge-zookeeper/index.html +++ b/docs/@vertx/service-discovery-bridge-zookeeper/index.html @@ -62,6 +62,39 @@

    @vertx/service-discovery-bridge-zookeeper

    +

    npm (scoped) + npm

    +

    Generated JavaScript bindings for Eclipse Vert.x.

    +

    Documentation

    + +

    Usage

    +

    Import the required API/Enum/DataObject and profit!

    + 
    // Base API
+const Api = require('@vertx/service-discovery-zookeeper');
+// Base ENUMs
+const Enums = require('@vertx/service-discovery-zookeeper/enums');
+// DataObject's
+const Options = require('@vertx/service-discovery-zookeeper/options');
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
    +

    Typescript

    +

    This package includes Typescript typedefinitions and your IDE should find then automatically.

    +

    When working in a project you can enable type hinting for the runtime as:

    + 
    /// <definition types="@vertx/core/runtime" />
+// @ts-check
+
+// your TypeScript code here...
    + +
    diff --git a/docs/@vertx/service-discovery/assets/js/search.js b/docs/@vertx/service-discovery/assets/js/search.js index fdc6377e3..e840dc378 100644 --- a/docs/@vertx/service-discovery/assets/js/search.js +++ b/docs/@vertx/service-discovery/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"Status","url":"enums/status.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"UP","url":"enums/status.html#up","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":2,"kind":16,"name":"DOWN","url":"enums/status.html#down","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":3,"kind":16,"name":"OUT_OF_SERVICE","url":"enums/status.html#out_of_service","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":4,"kind":16,"name":"UNKNOWN","url":"enums/status.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":5,"kind":128,"name":"HttpLocation","url":"classes/httplocation.html","classes":"tsd-kind-class"},{"id":6,"kind":1024,"name":"endpoint","url":"classes/httplocation.html#endpoint","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpLocation"},{"id":7,"kind":1024,"name":"host","url":"classes/httplocation.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpLocation"},{"id":8,"kind":1024,"name":"port","url":"classes/httplocation.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpLocation"},{"id":9,"kind":1024,"name":"root","url":"classes/httplocation.html#root","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpLocation"},{"id":10,"kind":1024,"name":"ssl","url":"classes/httplocation.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpLocation"},{"id":11,"kind":128,"name":"Record","url":"classes/record.html","classes":"tsd-kind-class"},{"id":12,"kind":1024,"name":"location","url":"classes/record.html#location","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Record"},{"id":13,"kind":1024,"name":"metadata","url":"classes/record.html#metadata","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Record"},{"id":14,"kind":1024,"name":"name","url":"classes/record.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Record"},{"id":15,"kind":1024,"name":"registration","url":"classes/record.html#registration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Record"},{"id":16,"kind":1024,"name":"status","url":"classes/record.html#status","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Record"},{"id":17,"kind":1024,"name":"type","url":"classes/record.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Record"},{"id":18,"kind":128,"name":"ServiceDiscoveryOptions","url":"classes/servicediscoveryoptions.html","classes":"tsd-kind-class"},{"id":19,"kind":1024,"name":"announceAddress","url":"classes/servicediscoveryoptions.html#announceaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":20,"kind":1024,"name":"autoRegistrationOfImporters","url":"classes/servicediscoveryoptions.html#autoregistrationofimporters","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":21,"kind":1024,"name":"backendConfiguration","url":"classes/servicediscoveryoptions.html#backendconfiguration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":22,"kind":1024,"name":"name","url":"classes/servicediscoveryoptions.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":23,"kind":1024,"name":"usageAddress","url":"classes/servicediscoveryoptions.html#usageaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":24,"kind":128,"name":"EventBusService","url":"classes/eventbusservice.html","classes":"tsd-kind-class"},{"id":25,"kind":2048,"name":"createRecord","url":"classes/eventbusservice.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"EventBusService"},{"id":26,"kind":2048,"name":"getServiceProxy","url":"classes/eventbusservice.html#getserviceproxy","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"EventBusService"},{"id":27,"kind":2048,"name":"getServiceProxyWithJsonFilter","url":"classes/eventbusservice.html#getserviceproxywithjsonfilter","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"EventBusService"},{"id":28,"kind":128,"name":"HttpEndpoint","url":"classes/httpendpoint.html","classes":"tsd-kind-class"},{"id":29,"kind":2048,"name":"createRecord","url":"classes/httpendpoint.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HttpEndpoint"},{"id":30,"kind":2048,"name":"getClient","url":"classes/httpendpoint.html#getclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HttpEndpoint"},{"id":31,"kind":2048,"name":"getWebClient","url":"classes/httpendpoint.html#getwebclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HttpEndpoint"},{"id":32,"kind":128,"name":"JDBCDataSource","url":"classes/jdbcdatasource.html","classes":"tsd-kind-class"},{"id":33,"kind":2048,"name":"createRecord","url":"classes/jdbcdatasource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCDataSource"},{"id":34,"kind":2048,"name":"getJDBCClient","url":"classes/jdbcdatasource.html#getjdbcclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCDataSource"},{"id":35,"kind":128,"name":"MessageSource","url":"classes/messagesource.html","classes":"tsd-kind-class"},{"id":36,"kind":2048,"name":"createRecord","url":"classes/messagesource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MessageSource"},{"id":37,"kind":2048,"name":"getConsumer","url":"classes/messagesource.html#getconsumer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MessageSource"},{"id":38,"kind":128,"name":"MongoDataSource","url":"classes/mongodatasource.html","classes":"tsd-kind-class"},{"id":39,"kind":2048,"name":"createRecord","url":"classes/mongodatasource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MongoDataSource"},{"id":40,"kind":2048,"name":"getMongoClient","url":"classes/mongodatasource.html#getmongoclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MongoDataSource"},{"id":41,"kind":128,"name":"RedisDataSource","url":"classes/redisdatasource.html","classes":"tsd-kind-class"},{"id":42,"kind":2048,"name":"createRecord","url":"classes/redisdatasource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RedisDataSource"},{"id":43,"kind":2048,"name":"getRedisClient","url":"classes/redisdatasource.html#getredisclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RedisDataSource"},{"id":44,"kind":128,"name":"ServiceDiscovery","url":"classes/servicediscovery.html","classes":"tsd-kind-class"},{"id":45,"kind":2048,"name":"create","url":"classes/servicediscovery.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ServiceDiscovery"},{"id":46,"kind":2048,"name":"getReference","url":"classes/servicediscovery.html#getreference","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":47,"kind":2048,"name":"getReferenceWithConfiguration","url":"classes/servicediscovery.html#getreferencewithconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":48,"kind":2048,"name":"release","url":"classes/servicediscovery.html#release","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":49,"kind":2048,"name":"registerServiceImporter","url":"classes/servicediscovery.html#registerserviceimporter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":50,"kind":2048,"name":"registerServiceExporter","url":"classes/servicediscovery.html#registerserviceexporter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":51,"kind":2048,"name":"close","url":"classes/servicediscovery.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":52,"kind":2048,"name":"publish","url":"classes/servicediscovery.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":53,"kind":2048,"name":"unpublish","url":"classes/servicediscovery.html#unpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":54,"kind":2048,"name":"getRecord","url":"classes/servicediscovery.html#getrecord","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":55,"kind":2048,"name":"getRecords","url":"classes/servicediscovery.html#getrecords","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":56,"kind":2048,"name":"update","url":"classes/servicediscovery.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":57,"kind":2048,"name":"bindings","url":"classes/servicediscovery.html#bindings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":58,"kind":2048,"name":"options","url":"classes/servicediscovery.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":59,"kind":2048,"name":"releaseServiceObject","url":"classes/servicediscovery.html#releaseserviceobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ServiceDiscovery"},{"id":60,"kind":128,"name":"ServiceExporter","url":"classes/serviceexporter.html","classes":"tsd-kind-class"},{"id":61,"kind":2048,"name":"init","url":"classes/serviceexporter.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":62,"kind":2048,"name":"onPublish","url":"classes/serviceexporter.html#onpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":63,"kind":2048,"name":"onUpdate","url":"classes/serviceexporter.html#onupdate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":64,"kind":2048,"name":"onUnpublish","url":"classes/serviceexporter.html#onunpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":65,"kind":2048,"name":"close","url":"classes/serviceexporter.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":66,"kind":128,"name":"ServiceImporter","url":"classes/serviceimporter.html","classes":"tsd-kind-class"},{"id":67,"kind":2048,"name":"start","url":"classes/serviceimporter.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceImporter"},{"id":68,"kind":2048,"name":"close","url":"classes/serviceimporter.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceImporter"},{"id":69,"kind":128,"name":"ServicePublisher","url":"classes/servicepublisher.html","classes":"tsd-kind-class"},{"id":70,"kind":2048,"name":"publish","url":"classes/servicepublisher.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServicePublisher"},{"id":71,"kind":2048,"name":"unpublish","url":"classes/servicepublisher.html#unpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServicePublisher"},{"id":72,"kind":2048,"name":"update","url":"classes/servicepublisher.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServicePublisher"},{"id":73,"kind":128,"name":"ServiceReference","url":"classes/servicereference.html","classes":"tsd-kind-class"},{"id":74,"kind":2048,"name":"record","url":"classes/servicereference.html#record","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":75,"kind":2048,"name":"get","url":"classes/servicereference.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":76,"kind":2048,"name":"getAs","url":"classes/servicereference.html#getas","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":77,"kind":2048,"name":"cachedAs","url":"classes/servicereference.html#cachedas","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":78,"kind":2048,"name":"cached","url":"classes/servicereference.html#cached","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":79,"kind":2048,"name":"release","url":"classes/servicereference.html#release","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":80,"kind":2048,"name":"isHolding","url":"classes/servicereference.html#isholding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"Status","url":"enums/status.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"UP","url":"enums/status.html#up","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":2,"kind":16,"name":"DOWN","url":"enums/status.html#down","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":3,"kind":16,"name":"OUT_OF_SERVICE","url":"enums/status.html#out_of_service","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":4,"kind":16,"name":"UNKNOWN","url":"enums/status.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Status"},{"id":5,"kind":128,"name":"HttpLocation","url":"classes/httplocation.html","classes":"tsd-kind-class"},{"id":6,"kind":512,"name":"constructor","url":"classes/httplocation.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"HttpLocation"},{"id":7,"kind":2048,"name":"getEndpoint","url":"classes/httplocation.html#getendpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":8,"kind":2048,"name":"setEndpoint","url":"classes/httplocation.html#setendpoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":9,"kind":2048,"name":"getHost","url":"classes/httplocation.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":10,"kind":2048,"name":"setHost","url":"classes/httplocation.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":11,"kind":2048,"name":"getPort","url":"classes/httplocation.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":12,"kind":2048,"name":"setPort","url":"classes/httplocation.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":13,"kind":2048,"name":"getRoot","url":"classes/httplocation.html#getroot","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":14,"kind":2048,"name":"setRoot","url":"classes/httplocation.html#setroot","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":15,"kind":2048,"name":"isSsl","url":"classes/httplocation.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":16,"kind":2048,"name":"setSsl","url":"classes/httplocation.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpLocation"},{"id":17,"kind":128,"name":"Record","url":"classes/record.html","classes":"tsd-kind-class"},{"id":18,"kind":512,"name":"constructor","url":"classes/record.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Record"},{"id":19,"kind":2048,"name":"getLocation","url":"classes/record.html#getlocation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":20,"kind":2048,"name":"setLocation","url":"classes/record.html#setlocation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":21,"kind":2048,"name":"getMetadata","url":"classes/record.html#getmetadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":22,"kind":2048,"name":"setMetadata","url":"classes/record.html#setmetadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":23,"kind":2048,"name":"getName","url":"classes/record.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":24,"kind":2048,"name":"setName","url":"classes/record.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":25,"kind":2048,"name":"getRegistration","url":"classes/record.html#getregistration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":26,"kind":2048,"name":"setRegistration","url":"classes/record.html#setregistration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":27,"kind":2048,"name":"getStatus","url":"classes/record.html#getstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":28,"kind":2048,"name":"setStatus","url":"classes/record.html#setstatus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":29,"kind":2048,"name":"getType","url":"classes/record.html#gettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":30,"kind":2048,"name":"setType","url":"classes/record.html#settype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Record"},{"id":31,"kind":128,"name":"ServiceDiscoveryOptions","url":"classes/servicediscoveryoptions.html","classes":"tsd-kind-class"},{"id":32,"kind":512,"name":"constructor","url":"classes/servicediscoveryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":33,"kind":2048,"name":"getAnnounceAddress","url":"classes/servicediscoveryoptions.html#getannounceaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":34,"kind":2048,"name":"setAnnounceAddress","url":"classes/servicediscoveryoptions.html#setannounceaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":35,"kind":2048,"name":"isAutoRegistrationOfImporters","url":"classes/servicediscoveryoptions.html#isautoregistrationofimporters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":36,"kind":2048,"name":"setAutoRegistrationOfImporters","url":"classes/servicediscoveryoptions.html#setautoregistrationofimporters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":37,"kind":2048,"name":"getBackendConfiguration","url":"classes/servicediscoveryoptions.html#getbackendconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":38,"kind":2048,"name":"setBackendConfiguration","url":"classes/servicediscoveryoptions.html#setbackendconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":39,"kind":2048,"name":"getName","url":"classes/servicediscoveryoptions.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":40,"kind":2048,"name":"setName","url":"classes/servicediscoveryoptions.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":41,"kind":2048,"name":"getUsageAddress","url":"classes/servicediscoveryoptions.html#getusageaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":42,"kind":2048,"name":"setUsageAddress","url":"classes/servicediscoveryoptions.html#setusageaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscoveryOptions"},{"id":43,"kind":128,"name":"EventBusService","url":"classes/eventbusservice.html","classes":"tsd-kind-class"},{"id":44,"kind":2048,"name":"createRecord","url":"classes/eventbusservice.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"EventBusService"},{"id":45,"kind":2048,"name":"getServiceProxy","url":"classes/eventbusservice.html#getserviceproxy","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"EventBusService"},{"id":46,"kind":2048,"name":"getServiceProxyWithJsonFilter","url":"classes/eventbusservice.html#getserviceproxywithjsonfilter","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"EventBusService"},{"id":47,"kind":128,"name":"HttpEndpoint","url":"classes/httpendpoint.html","classes":"tsd-kind-class"},{"id":48,"kind":2048,"name":"createRecord","url":"classes/httpendpoint.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HttpEndpoint"},{"id":49,"kind":2048,"name":"getClient","url":"classes/httpendpoint.html#getclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HttpEndpoint"},{"id":50,"kind":2048,"name":"getWebClient","url":"classes/httpendpoint.html#getwebclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HttpEndpoint"},{"id":51,"kind":128,"name":"JDBCDataSource","url":"classes/jdbcdatasource.html","classes":"tsd-kind-class"},{"id":52,"kind":2048,"name":"createRecord","url":"classes/jdbcdatasource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCDataSource"},{"id":53,"kind":2048,"name":"getJDBCClient","url":"classes/jdbcdatasource.html#getjdbcclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"JDBCDataSource"},{"id":54,"kind":128,"name":"MessageSource","url":"classes/messagesource.html","classes":"tsd-kind-class"},{"id":55,"kind":2048,"name":"createRecord","url":"classes/messagesource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MessageSource"},{"id":56,"kind":2048,"name":"getConsumer","url":"classes/messagesource.html#getconsumer","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"MessageSource"},{"id":57,"kind":128,"name":"MongoDataSource","url":"classes/mongodatasource.html","classes":"tsd-kind-class"},{"id":58,"kind":2048,"name":"createRecord","url":"classes/mongodatasource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MongoDataSource"},{"id":59,"kind":2048,"name":"getMongoClient","url":"classes/mongodatasource.html#getmongoclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MongoDataSource"},{"id":60,"kind":128,"name":"RedisDataSource","url":"classes/redisdatasource.html","classes":"tsd-kind-class"},{"id":61,"kind":2048,"name":"createRecord","url":"classes/redisdatasource.html#createrecord","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RedisDataSource"},{"id":62,"kind":2048,"name":"getRedisClient","url":"classes/redisdatasource.html#getredisclient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RedisDataSource"},{"id":63,"kind":128,"name":"ServiceDiscovery","url":"classes/servicediscovery.html","classes":"tsd-kind-class"},{"id":64,"kind":2048,"name":"create","url":"classes/servicediscovery.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ServiceDiscovery"},{"id":65,"kind":2048,"name":"getReference","url":"classes/servicediscovery.html#getreference","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":66,"kind":2048,"name":"getReferenceWithConfiguration","url":"classes/servicediscovery.html#getreferencewithconfiguration","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":67,"kind":2048,"name":"release","url":"classes/servicediscovery.html#release","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":68,"kind":2048,"name":"registerServiceImporter","url":"classes/servicediscovery.html#registerserviceimporter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":69,"kind":2048,"name":"registerServiceExporter","url":"classes/servicediscovery.html#registerserviceexporter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":70,"kind":2048,"name":"close","url":"classes/servicediscovery.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":71,"kind":2048,"name":"publish","url":"classes/servicediscovery.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":72,"kind":2048,"name":"unpublish","url":"classes/servicediscovery.html#unpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":73,"kind":2048,"name":"getRecord","url":"classes/servicediscovery.html#getrecord","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":74,"kind":2048,"name":"getRecords","url":"classes/servicediscovery.html#getrecords","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":75,"kind":2048,"name":"update","url":"classes/servicediscovery.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":76,"kind":2048,"name":"bindings","url":"classes/servicediscovery.html#bindings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":77,"kind":2048,"name":"options","url":"classes/servicediscovery.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceDiscovery"},{"id":78,"kind":2048,"name":"releaseServiceObject","url":"classes/servicediscovery.html#releaseserviceobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ServiceDiscovery"},{"id":79,"kind":128,"name":"ServiceExporter","url":"classes/serviceexporter.html","classes":"tsd-kind-class"},{"id":80,"kind":2048,"name":"init","url":"classes/serviceexporter.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":81,"kind":2048,"name":"onPublish","url":"classes/serviceexporter.html#onpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":82,"kind":2048,"name":"onUpdate","url":"classes/serviceexporter.html#onupdate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":83,"kind":2048,"name":"onUnpublish","url":"classes/serviceexporter.html#onunpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":84,"kind":2048,"name":"close","url":"classes/serviceexporter.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceExporter"},{"id":85,"kind":128,"name":"ServiceImporter","url":"classes/serviceimporter.html","classes":"tsd-kind-class"},{"id":86,"kind":2048,"name":"start","url":"classes/serviceimporter.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceImporter"},{"id":87,"kind":2048,"name":"close","url":"classes/serviceimporter.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceImporter"},{"id":88,"kind":128,"name":"ServicePublisher","url":"classes/servicepublisher.html","classes":"tsd-kind-class"},{"id":89,"kind":2048,"name":"publish","url":"classes/servicepublisher.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServicePublisher"},{"id":90,"kind":2048,"name":"unpublish","url":"classes/servicepublisher.html#unpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServicePublisher"},{"id":91,"kind":2048,"name":"update","url":"classes/servicepublisher.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServicePublisher"},{"id":92,"kind":128,"name":"ServiceReference","url":"classes/servicereference.html","classes":"tsd-kind-class"},{"id":93,"kind":2048,"name":"record","url":"classes/servicereference.html#record","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":94,"kind":2048,"name":"get","url":"classes/servicereference.html#get","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"ServiceReference"},{"id":95,"kind":2048,"name":"getAs","url":"classes/servicereference.html#getas","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"ServiceReference"},{"id":96,"kind":2048,"name":"cachedAs","url":"classes/servicereference.html#cachedas","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"ServiceReference"},{"id":97,"kind":2048,"name":"cached","url":"classes/servicereference.html#cached","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"ServiceReference"},{"id":98,"kind":2048,"name":"release","url":"classes/servicereference.html#release","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"},{"id":99,"kind":2048,"name":"isHolding","url":"classes/servicereference.html#isholding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServiceReference"}]}; \ No newline at end of file diff --git a/docs/@vertx/service-discovery/classes/eventbusservice.html b/docs/@vertx/service-discovery/classes/eventbusservice.html index feea99ef7..cf364085b 100644 --- a/docs/@vertx/service-discovery/classes/eventbusservice.html +++ b/docs/@vertx/service-discovery/classes/eventbusservice.html @@ -80,8 +80,8 @@

    Index

    Methods

    @@ -100,12 +100,12 @@

    Static createRecord

  • -

    Sugar method to creates a record for this type. +

    Sugar method to creates a record for this type.

    The java interface is added to the metadata in the service.interface key.

    @@ -135,6 +135,11 @@
    metadata: object

    the metadata

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns Record

    @@ -143,12 +148,12 @@

    Returns
    -

    Creates a record based on the parameters.

    +

    Creates a record based on the parameters.

    Parameters

    @@ -177,27 +182,36 @@

    Returns +

    Static getServiceProxy

    -
      -
    • getServiceProxy(discovery: ServiceDiscovery, filter: function, clientClass: Class, resultHandler: function): Object
      • +
        +
      • getServiceProxy<T>(discovery: ServiceDiscovery, filter: function, clientClass: any, resultHandler: function): T
      • -

        Lookup for a service record and if found, retrieve it and return the service object (used to consume the service). +

        Lookup for a service record and if found, retrieve it and return the service object (used to consume the service). This is a convenient method to avoid explicit lookup and then retrieval of the service. This method requires to have the {@code clientClass} set with the expected set of client. This is important for usages not using Java so you can pass the expected type.

        +

        Type parameters

        +
          +
        • +

          T

          +
          +

          the type of the client class

          +
          +
          • +

        Parameters

        • @@ -214,14 +228,14 @@
          filter: function

            • Parameters

              Returns boolean

              @@ -231,7 +245,7 @@

              Returns boolean

            • -
              clientClass: Class
              +
              clientClass: any

              the client class

              @@ -244,51 +258,63 @@
              resultHandler: function
                • -
                • (result: AsyncResult<any>): void
                  • +
                • (res: AsyncResult<T>): void | Handler<AsyncResult<T>>

                • Parameters

                  • -
                    result: AsyncResult<any>
                    +
                    res: AsyncResult<T>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<T>> +

            -

            Returns Object

            +

            Returns T

            • do not use
    -
    +

    Static getServiceProxyWithJsonFilter

    -
      -
    • getServiceProxyWithJsonFilter(discovery: ServiceDiscovery, filter: object, clientClass: Class, resultHandler: function): Object
      • +
        +
      • getServiceProxyWithJsonFilter<T>(discovery: ServiceDiscovery, filter: object, clientClass: any, resultHandler: function): T
      • -

        Lookup for a service record and if found, retrieve it and return the service object (used to consume the service). +

        Lookup for a service record and if found, retrieve it and return the service object (used to consume the service). This is a convenient method to avoid explicit lookup and then retrieval of the service. This method requires to have the {@code clientClass} set with the expected set of client. This is important for usages not using Java so you can pass the expected type.

        +

        Type parameters

        +
          +
        • +

          T

          +
          +

          the type of the client class

          +
          +
          • +

        Parameters

        • @@ -302,9 +328,14 @@
          filter: object

          the filter as json object

          +
            +
          • +
            [key: string]: any
            +
            • +
        • -
          clientClass: Class
          +
          clientClass: any

          the client class

          @@ -317,24 +348,27 @@
          resultHandler: function
            • -
            • (result: AsyncResult<any>): void
              • +
            • (res: AsyncResult<T>): void | Handler<AsyncResult<T>>

            • Parameters

              • -
                result: AsyncResult<any>
                +
                res: AsyncResult<T>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<T>> +

        -

        Returns Object

        +

        Returns T

        • do not use
        @@ -364,10 +398,10 @@

        Returns Object createRecord

        • -
      • +
      • getServiceProxy
        • -
      • +
      • getServiceProxyWithJsonFilter
      diff --git a/docs/@vertx/service-discovery/classes/httpendpoint.html b/docs/@vertx/service-discovery/classes/httpendpoint.html index e6f211dae..37735e72e 100644 --- a/docs/@vertx/service-discovery/classes/httpendpoint.html +++ b/docs/@vertx/service-discovery/classes/httpendpoint.html @@ -102,12 +102,12 @@

      Static createRecord

    • -

      Convenient method to create a record for a HTTP endpoint.

      +

      Convenient method to create a record for a HTTP endpoint.

      Parameters

      @@ -141,6 +141,11 @@
      metadata: object

      additional metadata

      +
        +
      • +
        [key: string]: any
        +
        • +

    Returns Record

    @@ -149,12 +154,12 @@

    Returns
    -

    Same as {@link #createRecord(String, String, int, String, JsonObject)} but let you configure whether or not the +

    Same as {@link #createRecord(String, String, int, String, JsonObject)} but let you configure whether or not the service is using {@code https}.

    @@ -195,6 +200,11 @@
    metadata: object

    additional metadata

    +
      +
    • +
      [key: string]: any
      +
      • +

    Returns Record

    @@ -203,12 +213,12 @@

    Returns
    -

    Same as {@link #createRecord(String, String, int, String, JsonObject)} but without metadata.

    +

    Same as {@link #createRecord(String, String, int, String, JsonObject)} but without metadata.

    Parameters

    @@ -244,12 +254,12 @@

    Returns
    -

    Same as {@link #createRecord(String, String, int, String, JsonObject)} but without metadata, using the port 80 +

    Same as {@link #createRecord(String, String, int, String, JsonObject)} but without metadata, using the port 80 and using "/" as root.

    @@ -286,12 +296,12 @@

    Static getClient

  • -

    Convenient method that looks for a HTTP endpoint and provides the configured {@link HttpClient}. The async result +

    Convenient method that looks for a HTTP endpoint and provides the configured {@link HttpClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

    @@ -308,6 +318,11 @@
    filter: object

    The filter, optional

    +
      +
    • +
      [key: string]: any
      +
      • +
  • resultHandler: function
    @@ -317,17 +332,20 @@
    resultHandler: function

    • -

    Properties

    -
    - -

    endpoint

    -
    endpoint: string
    - -
    -
    -

    Sets the endpoint, which is the URL of the service. The endpoint is automatically computed when you use the - other setX method.

    -
    -
    -
    param
    -

    the endpoint

    -
    -
    returns
    -

    the current HttpLocation

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Sets the host.

    -
    -
    -
    param
    -

    the host

    -
    -
    returns
    -

    the current HttpLocation

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getEndpoint

    +
      +
    • getEndpoint(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the endpoint, which is the URL of the service. The endpoint is automatically computed when you use the + other setX method.

      +
      +
      +

      Returns string

      +

      the current HttpLocation

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Sets the port

    -
    -
    -
    param
    -

    the port

    -
    -
    returns
    -

    the current HttpLocation

    -
    -
    -
    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the host.

      +
      +
      +

      Returns string

      +

      the current HttpLocation

      +
      • +
    -
    - -

    root

    -
    root: string
    - -
    -
    -

    Sets the path of the service (root)

    -
    -
    -
    param
    -

    the root

    -
    -
    returns
    -

    the current HttpLocation

    -
    -
    -
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the port

      +
      +
      +

      Returns number

      +

      the current HttpLocation

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - -
    -
    -

    Sets whether or not the HTTP service is using {@code https}.

    -
    -
    -
    param
    -

    to denotes that the service use {@code https}

    -
    -
    returns
    -

    the current HttpLocation

    -
    -
    -
    +
    + +

    getRoot

    +
      +
    • getRoot(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the path of the service (root)

      +
      +
      +

      Returns string

      +

      the current HttpLocation

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the HTTP service is using {@code https}.

      +
      +
      +

      Returns boolean

      +

      the current HttpLocation

      +
      • +
    +
    +
    + +

    setEndpoint

    + +
      +
    • + +
      +
      +

      Sets the endpoint, which is the URL of the service. The endpoint is automatically computed when you use the + other setX method.

      +
      +
      +

      Parameters

      +
        +
      • +
        endpoint: string
        +
        +

        the endpoint

        +
        +
        • +
      +

      Returns HttpLocation

      +

      the current HttpLocation

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Sets the host.

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the host

        +
        +
        • +
      +

      Returns HttpLocation

      +

      the current HttpLocation

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Sets the port

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns HttpLocation

      +

      the current HttpLocation

      +
      • +
    +
    +
    + +

    setRoot

    + +
      +
    • + +
      +
      +

      Sets the path of the service (root)

      +
      +
      +

      Parameters

      +
        +
      • +
        root: string
        +
        +

        the root

        +
        +
        • +
      +

      Returns HttpLocation

      +

      the current HttpLocation

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +
      +
      +

      Sets whether or not the HTTP service is using {@code https}.

      +
      +
      +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        +

        to denotes that the service use {@code https}

        +
        +
        • +
      +

      Returns HttpLocation

      +

      the current HttpLocation

      +
      • +
    @@ -233,20 +440,38 @@

    ssl

  • HttpLocation
    • diff --git a/docs/@vertx/service-discovery/classes/jdbcdatasource.html b/docs/@vertx/service-discovery/classes/jdbcdatasource.html index fcc26ac2b..37946b169 100644 --- a/docs/@vertx/service-discovery/classes/jdbcdatasource.html +++ b/docs/@vertx/service-discovery/classes/jdbcdatasource.html @@ -98,7 +98,7 @@

    Static createRecord

  • Parameters

    @@ -108,9 +108,19 @@
    name: string
  • location: object
    +
      +
    • +
      [key: string]: any
      +
      • +
  • metadata: object
    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns Record

    @@ -130,12 +140,12 @@

    Static getJDBCClient

  • -

    Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The +

    Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

    @@ -152,6 +162,11 @@
    filter: object

    The filter, optional

    +
      +
    • +
      [key: string]: any
      +
      • +
  • resultHandler: function
    @@ -161,17 +176,20 @@
    resultHandler: function
      • -
      • (result: AsyncResult<JDBCClient>): void
        • +
      • (res: AsyncResult<JDBCClient>): void | Handler<AsyncResult<JDBCClient>>

      • Parameters

        • -
          result: AsyncResult<JDBCClient>
          +
          res: AsyncResult<JDBCClient>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<JDBCClient>> +

      • @@ -183,12 +201,12 @@

      Returns void
      -

      Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The +

      Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

      @@ -208,14 +226,14 @@
      filter: function

        • Parameters

          Returns boolean

          @@ -232,17 +250,20 @@
          resultHandler: function
            • -
            • (result: AsyncResult<JDBCClient>): void
              • +
            • (res: AsyncResult<JDBCClient>): void | Handler<AsyncResult<JDBCClient>>

            • Parameters

              • -
                result: AsyncResult<JDBCClient>
                +
                res: AsyncResult<JDBCClient>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<JDBCClient>> +

            • @@ -254,12 +275,12 @@

            Returns void
            -

            Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The +

            Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

            @@ -276,12 +297,22 @@
            filter: object

            The filter, optional

            +
              +
            • +
              [key: string]: any
              +
              • +
          • consumerConfiguration: object

            the consumer configuration

            +
              +
            • +
              [key: string]: any
              +
              • +
          • resultHandler: function
            @@ -291,17 +322,20 @@
            resultHandler: function
              • -
              • (result: AsyncResult<JDBCClient>): void
                • +
              • (res: AsyncResult<JDBCClient>): void | Handler<AsyncResult<JDBCClient>>

              • Parameters

                • -
                  result: AsyncResult<JDBCClient>
                  +
                  res: AsyncResult<JDBCClient>
                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<JDBCClient>> +

              • @@ -313,12 +347,12 @@

              Returns void
              -

              Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The +

              Convenient method that looks for a JDBC datasource source and provides the configured {@link io.vertx.ext.jdbc.JDBCClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

              @@ -338,14 +372,14 @@
              filter: function

                • Parameters

                  Returns boolean

                  @@ -359,6 +393,11 @@
                  consumerConfiguration: object

                  the consumer configuration

                  +
                    +
                  • +
                    [key: string]: any
                    +
                    • +
                • resultHandler: function
                  @@ -368,17 +407,20 @@
                  resultHandler: function
                    • -
                    • (result: AsyncResult<JDBCClient>): void
                      • +
                    • (res: AsyncResult<JDBCClient>): void | Handler<AsyncResult<JDBCClient>>

                    • Parameters

                      • -
                        result: AsyncResult<JDBCClient>
                        +
                        res: AsyncResult<JDBCClient>
                      -

                      Returns void

                      +

                      Returns void + | + Handler<AsyncResult<JDBCClient>> +

                    • diff --git a/docs/@vertx/service-discovery/classes/messagesource.html b/docs/@vertx/service-discovery/classes/messagesource.html index 3f91cd1dc..a64405a87 100644 --- a/docs/@vertx/service-discovery/classes/messagesource.html +++ b/docs/@vertx/service-discovery/classes/messagesource.html @@ -80,7 +80,7 @@

                    Index

                    Methods

    • @@ -100,12 +100,12 @@

    Static createRecord

  • -

    Create a record representing a data producer.

    +

    Create a record representing a data producer.

    Parameters

    @@ -133,6 +133,11 @@
    metadata: object

    additional metadata

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns Record

    @@ -141,12 +146,12 @@

    Returns
    -

    Same as {@link #createRecord(String, String, String, JsonObject)} without additional metadata.

    +

    Same as {@link #createRecord(String, String, String, JsonObject)} without additional metadata.

    Parameters

    @@ -176,12 +181,12 @@

    Returns
    -

    Same as {@link #createRecord(String, String, Class, JsonObject)} without additional metadata, and no type for +

    Same as {@link #createRecord(String, String, Class, JsonObject)} without additional metadata, and no type for the payload.

    @@ -205,26 +210,35 @@

    Returns +

    Static getConsumer

    -
      -
    • getConsumer(discovery: ServiceDiscovery, filter: object, resultHandler: function): void
      • -
    • getConsumer(discovery: ServiceDiscovery, filter: function, resultHandler: function): void
      • +
        +
      • getConsumer<T>(discovery: ServiceDiscovery, filter: object, resultHandler: function): void
        • +
      • getConsumer<T>(discovery: ServiceDiscovery, filter: function, resultHandler: function): void
      • -

        Convenient method that looks for a message source and provides the configured {@link MessageConsumer}. The +

        Convenient method that looks for a message source and provides the configured {@link MessageConsumer}. The async result is marked as failed is there are no matching services, or if the lookup fails.

        +

        Type parameters

        +
          +
        • +

          T

          +
          +

          The class of the message

          +
          +
          • +

        Parameters

        • @@ -238,6 +252,11 @@
          filter: object

          The filter, optional

          +
            +
          • +
            [key: string]: any
            +
            • +
        • resultHandler: function
          @@ -247,17 +266,20 @@
          resultHandler: function
            • -
            • (result: AsyncResult<MessageConsumer>): void
              • +
            • (res: AsyncResult<MessageConsumer<T>>): void | Handler<AsyncResult<MessageConsumer<T>>>

            • Parameters

              • -
                result: AsyncResult<MessageConsumer>
                +
                res: AsyncResult<MessageConsumer<T>>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<MessageConsumer<T>>> +

            • @@ -269,15 +291,24 @@

            Returns void
            -

            Convenient method that looks for a message source and provides the configured {@link MessageConsumer}. The +

            Convenient method that looks for a message source and provides the configured {@link MessageConsumer}. The async result is marked as failed is there are no matching services, or if the lookup fails.

            +

            Type parameters

            +
              +
            • +

              T

              +
              +

              The class of the message

              +
              +
              • +

            Parameters

            • @@ -294,14 +325,14 @@
              filter: function

                • Parameters

                  Returns boolean

                  @@ -318,17 +349,20 @@
                  resultHandler: function
                    • -
                    • (result: AsyncResult<MessageConsumer>): void
                      • +
                    • (res: AsyncResult<MessageConsumer<T>>): void | Handler<AsyncResult<MessageConsumer<T>>>

                    • Parameters

                      • -
                        result: AsyncResult<MessageConsumer>
                        +
                        res: AsyncResult<MessageConsumer<T>>
                      -

                      Returns void

                      +

                      Returns void + | + Handler<AsyncResult<MessageConsumer<T>>> +

                    • @@ -374,7 +408,7 @@

                    Returns void createRecord -
                  • +
                  • getConsumer

                  diff --git a/docs/@vertx/service-discovery/classes/mongodatasource.html b/docs/@vertx/service-discovery/classes/mongodatasource.html index d15bd9ecb..799605ae0 100644 --- a/docs/@vertx/service-discovery/classes/mongodatasource.html +++ b/docs/@vertx/service-discovery/classes/mongodatasource.html @@ -98,12 +98,12 @@

                  Static createRecord

                • -

                  Convenient method to create a record for a Mongo data source.

                  +

                  Convenient method to create a record for a Mongo data source.

                  Parameters

                  @@ -119,12 +119,22 @@
                  location: object

                  the location of the service (e.g. url, port...)

                  +
                    +
                  • +
                    [key: string]: any
                    +
                    • +
                • metadata: object

                  additional metadata

                  +
                    +
                  • +
                    [key: string]: any
                    +
                    • +

                Returns Record

                @@ -144,12 +154,12 @@

                Static getMongoClient<
              • -

                Convenient method that looks for a Mongo datasource source and provides the configured {@link io.vertx.ext.mongo.MongoClient}. The +

                Convenient method that looks for a Mongo datasource source and provides the configured {@link io.vertx.ext.mongo.MongoClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

                @@ -166,6 +176,11 @@
                filter: object

                The filter, optional

                +
                  +
                • +
                  [key: string]: any
                  +
                  • +
              • resultHandler: function
                @@ -175,17 +190,20 @@
                resultHandler: function
                  • -
                  • (result: AsyncResult<MongoClient>): void
                    • +
                  • (res: AsyncResult<MongoClient>): void | Handler<AsyncResult<MongoClient>>

                  • Parameters

                    • -
                      result: AsyncResult<MongoClient>
                      +
                      res: AsyncResult<MongoClient>
                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<MongoClient>> +

                  • @@ -197,12 +215,12 @@

                  Returns void
                  -

                  Convenient method that looks for a Mongo datasource source and provides the configured +

                  Convenient method that looks for a Mongo datasource source and provides the configured {@link io.vertx.ext.mongo.MongoClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

                  @@ -223,14 +241,14 @@
                  filter: function

                    • Parameters

                      Returns boolean

                      @@ -247,17 +265,20 @@
                      resultHandler: function
                        • -
                        • (result: AsyncResult<MongoClient>): void
                          • +
                        • (res: AsyncResult<MongoClient>): void | Handler<AsyncResult<MongoClient>>

                        • Parameters

                          • -
                            result: AsyncResult<MongoClient>
                            +
                            res: AsyncResult<MongoClient>
                          -

                          Returns void

                          +

                          Returns void + | + Handler<AsyncResult<MongoClient>> +

                        • @@ -269,12 +290,12 @@

                        Returns void
                        -

                        Convenient method that looks for a Mongo datasource source and provides the configured {@link io.vertx.ext.mongo.MongoClient}. The +

                        Convenient method that looks for a Mongo datasource source and provides the configured {@link io.vertx.ext.mongo.MongoClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

                        @@ -291,12 +312,22 @@
                        filter: object

                        The filter, optional

                        +
                          +
                        • +
                          [key: string]: any
                          +
                          • +
                      • consumerConfiguration: object

                        the consumer configuration

                        +
                          +
                        • +
                          [key: string]: any
                          +
                          • +
                      • resultHandler: function
                        @@ -306,17 +337,20 @@
                        resultHandler: function

    -

    Properties

    -
    - -

    location

    -
    location: object
    - -
    -
    -

    Sets the json object describing the location of the service. By convention, this json object should contain - the {@link #ENDPOINT} entry.

    -
    -
    -
    param
    -

    the location

    -
    -
    returns
    -

    the current Record

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Record

      +
      • +
    • + +

      Parameters

      + +

      Returns Record

      +
      • +
    -
    - -

    metadata

    -
    metadata: object
    - -
    -
    -

    Gets the metadata attached to the record.

    -
    -
    -
    returns
    -

    the metadata, cannot be {@code null}.

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getLocation

    +
      +
    • getLocation(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the json object describing the location of the service. By convention, this json object should contain + the {@link #ENDPOINT} entry.

      +
      +
      +

      Returns object

      +

      the current Record

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Sets the name of the service. It can reflect the service name of the name of the provider.

    -
    -
    -
    param
    -

    the name

    -
    -
    returns
    -

    the current Record

    -
    -
    -
    +
    + +

    getMetadata

    +
      +
    • getMetadata(): object
      • +
    +
      +
    • + +
      +
      +

      Gets the metadata attached to the record.

      +
      +
      +

      Returns object

      +

      the metadata, cannot be {@code null}.

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    registration

    -
    registration: string
    - -
    -
    -

    Sets the registration id. This method is called when the service is published.

    -
    -
    -
    param
    -

    the registration id

    -
    -
    returns
    -

    the current Record

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the name of the service. It can reflect the service name of the name of the provider.

      +
      +
      +

      Returns string

      +

      the current Record

      +
      • +
    -
    - -

    status

    -
    status: Status
    - -
    -
    -

    Sets the status of the service. When published, the status is set to{@link Status#UP}. When withdrawn, the - status is set to {@link Status#DOWN}.

    -
    -
    -
    param
    -

    the status, must not be {@code null}

    -
    -
    returns
    -

    the current Record

    -
    -
    -
    +
    + +

    getRegistration

    +
      +
    • getRegistration(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the registration id. This method is called when the service is published.

      +
      +
      +

      Returns string

      +

      the current Record

      +
      • +
    -
    - -

    type

    -
    type: string
    - -
    -
    -

    Sets the type of service.

    -
    -
    -
    param
    -

    the type

    -
    -
    returns
    -

    the current Record

    -
    -
    -
    +
    + +

    getStatus

    + +
      +
    • + +
      +
      +

      Sets the status of the service. When published, the status is set to{@link Status#UP}. When withdrawn, the + status is set to {@link Status#DOWN}.

      +
      +
      +

      Returns Status

      +

      the current Record

      +
      • +
    +
    +
    + +

    getType

    +
      +
    • getType(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the type of service.

      +
      +
      +

      Returns string

      +

      the current Record

      +
      • +
    +
    +
    + +

    setLocation

    +
      +
    • setLocation(location: object): Record
      • +
    +
      +
    • + +
      +
      +

      Sets the json object describing the location of the service. By convention, this json object should contain + the {@link #ENDPOINT} entry.

      +
      +
      +

      Parameters

      +
        +
      • +
        location: object
        +
        +

        the location

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns Record

      +

      the current Record

      +
      • +
    +
    +
    + +

    setMetadata

    +
      +
    • setMetadata(metadata: object): Record
      • +
    +
      +
    • + +
      +
      +

      Gets the metadata attached to the record.

      +
      +
      +

      Parameters

      +
        +
      • +
        metadata: object
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns Record

      +

      the metadata, cannot be {@code null}.

      +
      • +
    +
    +
    + +

    setName

    +
      +
    • setName(name: string): Record
      • +
    +
      +
    • + +
      +
      +

      Sets the name of the service. It can reflect the service name of the name of the provider.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        the name

        +
        +
        • +
      +

      Returns Record

      +

      the current Record

      +
      • +
    +
    +
    + +

    setRegistration

    +
      +
    • setRegistration(registration: string): Record
      • +
    +
      +
    • + +
      +
      +

      Sets the registration id. This method is called when the service is published.

      +
      +
      +

      Parameters

      +
        +
      • +
        registration: string
        +
        • +
      +

      Returns Record

      +

      the current Record

      +
      • +
    +
    +
    + +

    setStatus

    + +
      +
    • + +
      +
      +

      Sets the status of the service. When published, the status is set to{@link Status#UP}. When withdrawn, the + status is set to {@link Status#DOWN}.

      +
      +
      +

      Parameters

      +
        +
      • +
        status: Status
        +
        +

        the status, must not be {@code null}

        +
        +
        • +
      +

      Returns Record

      +

      the current Record

      +
      • +
    +
    +
    + +

    setType

    +
      +
    • setType(type: string): Record
      • +
    +
      +
    • + +
      +
      +

      Sets the type of service.

      +
      +
      +

      Parameters

      +
        +
      • +
        type: string
        +
        +

        the type

        +
        +
        • +
      +

      Returns Record

      +

      the current Record

      +
      • +
    @@ -267,23 +525,44 @@

    type

  • Record
    • diff --git a/docs/@vertx/service-discovery/classes/redisdatasource.html b/docs/@vertx/service-discovery/classes/redisdatasource.html index 82efd1d53..a44b38c97 100644 --- a/docs/@vertx/service-discovery/classes/redisdatasource.html +++ b/docs/@vertx/service-discovery/classes/redisdatasource.html @@ -98,12 +98,12 @@

    Static createRecord

  • -

    Convenient method to create a record for a Redis data source.

    +

    Convenient method to create a record for a Redis data source.

    Parameters

    @@ -119,12 +119,22 @@
    location: object

    the location of the service (e.g. url, port...)

    +
      +
    • +
      [key: string]: any
      +
      • +
  • metadata: object

    additional metadata

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns Record

    @@ -145,12 +155,12 @@

    Static getRedisClient<
  • -

    Convenient method that looks for a Redis data source and provides the configured {@link io.vertx.redis.RedisClient}. +

    Convenient method that looks for a Redis data source and provides the configured {@link io.vertx.redis.RedisClient}. The async result is marked as failed is there are no matching services, or if the lookup fails.

    @@ -167,6 +177,11 @@
    filter: object

    The filter, optional

    +
      +
    • +
      [key: string]: any
      +
      • +
  • resultHandler: function
    @@ -176,17 +191,20 @@
    resultHandler: function

    • -

    Properties

    -
    - -

    announceAddress

    -
    announceAddress: string
    - -
    -
    -

    Sets the event bus address on which the service arrivals, departures and modifications are announced. This - address must be consistent in the whole application.

    -
    -
    -
    param
    -

    the address, must not be {@code null}

    -
    -
    returns
    -

    the current ServiceDiscoveryOptions

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    autoRegistrationOfImporters

    -
    autoRegistrationOfImporters: boolean
    - -
    -
    -

    Sets whether or not the registration of importers declared as SPI is enabled.

    -
    -
    -
    param
    -

    to enable the importation, {@code false} otherwise

    -
    -
    returns
    -

    the current ServiceDiscoveryOptions

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAnnounceAddress

    +
      +
    • getAnnounceAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the event bus address on which the service arrivals, departures and modifications are announced. This + address must be consistent in the whole application.

      +
      +
      +

      Returns string

      +

      the current ServiceDiscoveryOptions

      +
      • +
    -
    - -

    backendConfiguration

    -
    backendConfiguration: object
    - -
    -
    -

    Sets the configuration passed to the {@link ServiceDiscoveryBackend}. - Refer to the backend documentation to get more details on the requirements. The default backend - does not need any configuration.

    -
    -
    -
    param
    -

    the backend configuration

    -
    -
    returns
    -

    the current ServiceDiscoveryOptions

    -
    -
    -
    +
    + +

    getBackendConfiguration

    +
      +
    • getBackendConfiguration(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the configuration passed to the {@link ServiceDiscoveryBackend}. + Refer to the backend documentation to get more details on the requirements. The default backend + does not need any configuration.

      +
      +
      +

      Returns object

      +

      the current ServiceDiscoveryOptions

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    name

    -
    name: string
    - -
    -
    -

    Sets the service discovery name used in the service usage events. - If not set, the node id is used.

    -
    -
    -
    param
    -

    the name to use.

    -
    -
    returns
    -

    the current ServiceDiscoveryOptions

    -
    -
    -
    +
    + +

    getName

    +
      +
    • getName(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the service discovery name used in the service usage events. + If not set, the node id is used.

      +
      +
      +

      Returns string

      +

      the current ServiceDiscoveryOptions

      +
      • +
    -
    - -

    usageAddress

    -
    usageAddress: string
    - -
    -
    -

    Sets the usage address: the event bus address on which are sent the service usage events (bind / release).

    -
    -
    -
    param
    -

    the address, {@link null} to disable use service usage tracking

    -
    -
    returns
    -

    the current ServiceDiscoveryOptions

    -
    -
    -
    +
    + +

    getUsageAddress

    +
      +
    • getUsageAddress(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the usage address: the event bus address on which are sent the service usage events (bind / release).

      +
      +
      +

      Returns string

      +

      the current ServiceDiscoveryOptions

      +
      • +
    +
    +
    + +

    isAutoRegistrationOfImporters

    +
      +
    • isAutoRegistrationOfImporters(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the registration of importers declared as SPI is enabled.

      +
      +
      +

      Returns boolean

      +

      the current ServiceDiscoveryOptions

      +
      • +
    +
    +
    + +

    setAnnounceAddress

    + +
      +
    • + +
      +
      +

      Sets the event bus address on which the service arrivals, departures and modifications are announced. This + address must be consistent in the whole application.

      +
      +
      +

      Parameters

      +
        +
      • +
        announceAddress: string
        +
        +

        the address, must not be {@code null}

        +
        +
        • +
      +

      Returns ServiceDiscoveryOptions

      +

      the current ServiceDiscoveryOptions

      +
      • +
    +
    +
    + +

    setAutoRegistrationOfImporters

    + +
      +
    • + +
      +
      +

      Sets whether or not the registration of importers declared as SPI is enabled.

      +
      +
      +

      Parameters

      +
        +
      • +
        autoRegistrationOfImporters: boolean
        +
        +

        to enable the importation, {@code false} otherwise

        +
        +
        • +
      +

      Returns ServiceDiscoveryOptions

      +

      the current ServiceDiscoveryOptions

      +
      • +
    +
    +
    + +

    setBackendConfiguration

    + +
      +
    • + +
      +
      +

      Sets the configuration passed to the {@link ServiceDiscoveryBackend}. + Refer to the backend documentation to get more details on the requirements. The default backend + does not need any configuration.

      +
      +
      +

      Parameters

      +
        +
      • +
        backendConfiguration: object
        +
        +

        the backend configuration

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns ServiceDiscoveryOptions

      +

      the current ServiceDiscoveryOptions

      +
      • +
    +
    +
    + +

    setName

    + +
      +
    • + +
      +
      +

      Sets the service discovery name used in the service usage events. + If not set, the node id is used.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        the name to use.

        +
        +
        • +
      +

      Returns ServiceDiscoveryOptions

      +

      the current ServiceDiscoveryOptions

      +
      • +
    +
    +
    + +

    setUsageAddress

    + +
      +
    • + +
      +
      +

      Sets the usage address: the event bus address on which are sent the service usage events (bind / release).

      +
      +
      +

      Parameters

      +
        +
      • +
        usageAddress: string
        +
        +

        the address, {@link null} to disable use service usage tracking

        +
        +
        • +
      +

      Returns ServiceDiscoveryOptions

      +

      the current ServiceDiscoveryOptions

      +
      • +
    @@ -257,20 +477,38 @@

    usageAddress

  • ServiceDiscoveryOptions
    • diff --git a/docs/@vertx/service-discovery/classes/serviceexporter.html b/docs/@vertx/service-discovery/classes/serviceexporter.html index 695f2cd32..87a9efd64 100644 --- a/docs/@vertx/service-discovery/classes/serviceexporter.html +++ b/docs/@vertx/service-discovery/classes/serviceexporter.html @@ -101,12 +101,12 @@

    close

  • -

    Close the exporter

    +

    Close the exporter

    Parameters

    @@ -119,17 +119,20 @@
    closeHandler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -144,18 +147,18 @@

      Returns void

      init

        -
      • init(vertx: Vertx, publisher: ServicePublisher, configuration: object, future: Future): void
        • +
      • init(vertx: Vertx, publisher: ServicePublisher, configuration: object, future: Future<void>): void
      • -

        Starts the exporter.

        +

        Starts the exporter.

        Parameters

        @@ -177,9 +180,14 @@
        configuration: object

        the bridge configuration if any

        +
          +
        • +
          [key: string]: any
          +
          • +
      • -
        future: Future
        +
        future: Future<void>

        a future on which the bridge must report the completion of the starting

        @@ -199,12 +207,12 @@

        onPublish

      • -

        Notify a new record has been published, the record's registration can be used to uniquely +

        Notify a new record has been published, the record's registration can be used to uniquely identify the record

        @@ -231,12 +239,12 @@

        onUnpublish

      • -

        Notify an existing record has been removed

        +

        Notify an existing record has been removed

        Parameters

        @@ -262,12 +270,12 @@

        onUpdate

      • -

        Notify an existing record has been updated, the record's registration can be used to uniquely +

        Notify an existing record has been updated, the record's registration can be used to uniquely identify the record

        diff --git a/docs/@vertx/service-discovery/classes/serviceimporter.html b/docs/@vertx/service-discovery/classes/serviceimporter.html index 7ba105d8c..b54560d73 100644 --- a/docs/@vertx/service-discovery/classes/serviceimporter.html +++ b/docs/@vertx/service-discovery/classes/serviceimporter.html @@ -98,12 +98,12 @@

        close

      • -

        Closes the importer

        +

        Closes the importer

        Parameters

        @@ -116,17 +116,20 @@
        closeHandler: function
          • -
          • (result: void): void
            • +
          • (res: void): void | Handler<void>

          • Parameters

            • -
              result: void
              +
              res: void
            -

            Returns void

            +

            Returns void + | + Handler<void> +

          • @@ -141,18 +144,18 @@

          Returns void

          start

            -
          • start(vertx: Vertx, publisher: ServicePublisher, configuration: object, future: Future): void
            • +
          • start(vertx: Vertx, publisher: ServicePublisher, configuration: object, future: Future<void>): void
          • -

            Starts the importer.

            +

            Starts the importer.

            Parameters

            @@ -174,9 +177,14 @@
            configuration: object

            the bridge configuration if any

            +
              +
            • +
              [key: string]: any
              +
              • +
          • -
            future: Future
            +
            future: Future<void>

            a future on which the bridge must report the completion of the starting

            diff --git a/docs/@vertx/service-discovery/classes/servicepublisher.html b/docs/@vertx/service-discovery/classes/servicepublisher.html index 41b954368..303483ce0 100644 --- a/docs/@vertx/service-discovery/classes/servicepublisher.html +++ b/docs/@vertx/service-discovery/classes/servicepublisher.html @@ -99,12 +99,12 @@

            publish

          • -

            Publishes a record.

            +

            Publishes a record.

            Parameters

            @@ -124,17 +124,20 @@
            resultHandler: function
              • -
              • (result: AsyncResult<Record>): void
                • +
              • (res: AsyncResult<Record>): void | Handler<AsyncResult<Record>>

              • Parameters

                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<Record>> +

              • @@ -155,12 +158,12 @@

              unpublish

            • -

              Un-publishes a record.

              +

              Un-publishes a record.

              Parameters

              @@ -179,17 +182,20 @@
              resultHandler: function
                • -
                • (result: AsyncResult<void>): void
                  • +
                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                • Parameters

                  • -
                    result: AsyncResult<void>
                    +
                    res: AsyncResult<void>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<void>> +

                • @@ -210,12 +216,12 @@

                update

              • -

                Updates an existing record.

                +

                Updates an existing record.

                Parameters

                @@ -235,17 +241,20 @@
                resultHandler: function
                  • -
                  • (result: AsyncResult<Record>): void
                    • +
                  • (res: AsyncResult<Record>): void | Handler<AsyncResult<Record>>

                  • Parameters

                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<Record>> +

                  • diff --git a/docs/@vertx/service-discovery/classes/servicereference.html b/docs/@vertx/service-discovery/classes/servicereference.html index d708812a5..2054ad2de 100644 --- a/docs/@vertx/service-discovery/classes/servicereference.html +++ b/docs/@vertx/service-discovery/classes/servicereference.html @@ -79,10 +79,10 @@

                  Index

                  Methods

                  Methods

                  -
                  +

                  cached

                  -
                    -
                  • cached(): Object
                    • +
                      +
                    • cached<T>(): T
                    • -

                      Gets the service object if already retrieved. It won't try to acquire the service object if not retrieved yet.

                      +

                      Gets the service object if already retrieved. It won't try to acquire the service object if not retrieved yet.

                      -

                      Returns Object

                      +

                      Type parameters

                      +
                        +
                      • +

                        T

                        +
                        • +
                      +

                      Returns T

                      the object, {@code null} if not yet retrieved

                  -
                  +

                  cachedAs

                  -
                    -
                  • cachedAs(x: Class): Object
                    • +
                      +
                    • cachedAs<X>(x: any): X
                    • -

                      Gets the service object if already retrieved. It won't try to acquire the service object if not retrieved yet. +

                      Gets the service object if already retrieved. It won't try to acquire the service object if not retrieved yet. Unlike {@link #cached()}, this method return the warpped object to the desired (given) type.

                      +

                      Type parameters

                      +
                        +
                      • +

                        X

                        +
                        +

                        the type of object

                        +
                        +
                        • +

                      Parameters

                      • -
                        x: Class
                        +
                        x: any

                        the type of object

                      -

                      Returns Object

                      +

                      Returns X

                      the object, {@code null} if not yet retrieved

                  -
                  +

                  get

                  -
                    -
                  • get(): Object
                    • +
                      +
                    • get<T>(): T
                    • -

                      Gets the object to access the service. It can be a proxy, a client or whatever object. The type depends on the +

                      Gets the object to access the service. It can be a proxy, a client or whatever object. The type depends on the service type and the server itself. This method returns the Java version and primary facet of the object, use {@link #getAs(Class)} to retrieve the polyglot instance of the object or another facet..

                      -

                      Returns Object

                      +

                      Type parameters

                      +
                        +
                      • +

                        T

                        +
                        • +
                      +

                      Returns T

                      the object to access the service

                  -
                  +

                  getAs

                  -
                    -
                  • getAs(x: Class): Object
                    • +
                      +
                    • getAs<X>(x: any): X
                    • -

                      Gets the object to access the service. It can be a proxy, a client or whatever object. The type depends on the +

                      Gets the object to access the service. It can be a proxy, a client or whatever object. The type depends on the service type and the server itself. This method wraps the service object into the desired type.

                      +

                      Type parameters

                      +
                        +
                      • +

                        X

                        +
                        +

                        the type of object

                        +
                        +
                        • +

                      Parameters

                      • -
                        x: Class
                        +
                        x: any

                        the type of object

                      -

                      Returns Object

                      +

                      Returns X

                      the object to access the service wrapped to the given type

                    @@ -217,12 +247,12 @@

                    isHolding

                  • -

                    Checks whether or not the service reference has the given service object.

                    +

                    Checks whether or not the service reference has the given service object.

                    Parameters

                    @@ -249,7 +279,7 @@

                    record

                  • @@ -269,12 +299,12 @@

                    release

                  • -

                    Releases the reference. Once released, the consumer must not use the reference anymore. +

                    Releases the reference. Once released, the consumer must not use the reference anymore. This method must be idempotent and defensive, as multiple call may happen.

                    @@ -341,16 +371,16 @@

                    Returns void ServiceReference
                      -
                    • +
                    • cached
                      • -
                    • +
                    • cachedAs
                      • -
                    • +
                    • get
                      • -
                    • +
                    • getAs
                    • diff --git a/docs/@vertx/service-discovery/enums/status.html b/docs/@vertx/service-discovery/enums/status.html index 389ade5a9..5d6431bb2 100644 --- a/docs/@vertx/service-discovery/enums/status.html +++ b/docs/@vertx/service-discovery/enums/status.html @@ -88,7 +88,7 @@

                      DOWN

                      DOWN:

                  @@ -98,7 +98,7 @@

                  OUT_OF_SERVICE

                  OUT_OF_SERVICE:
                  @@ -108,7 +108,7 @@

                  UNKNOWN

                  UNKNOWN:
                  @@ -118,7 +118,7 @@

                  UP

                  UP:
                  diff --git a/docs/@vertx/shell/assets/js/search.js b/docs/@vertx/shell/assets/js/search.js index 4945735b2..4c2338f98 100644 --- a/docs/@vertx/shell/assets/js/search.js +++ b/docs/@vertx/shell/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"ExecStatus","url":"enums/execstatus.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"READY","url":"enums/execstatus.html#ready","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":2,"kind":16,"name":"RUNNING","url":"enums/execstatus.html#running","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":3,"kind":16,"name":"STOPPED","url":"enums/execstatus.html#stopped","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":4,"kind":16,"name":"TERMINATED","url":"enums/execstatus.html#terminated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":5,"kind":128,"name":"HttpTermOptions","url":"classes/httptermoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":1024,"name":"acceptBacklog","url":"classes/httptermoptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":7,"kind":1024,"name":"acceptUnmaskedFrames","url":"classes/httptermoptions.html#acceptunmaskedframes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":8,"kind":1024,"name":"alpnVersions","url":"classes/httptermoptions.html#alpnversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":9,"kind":1024,"name":"charset","url":"classes/httptermoptions.html#charset","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":10,"kind":1024,"name":"clientAuth","url":"classes/httptermoptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":11,"kind":1024,"name":"clientAuthRequired","url":"classes/httptermoptions.html#clientauthrequired","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":12,"kind":1024,"name":"compressionLevel","url":"classes/httptermoptions.html#compressionlevel","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":13,"kind":1024,"name":"compressionSupported","url":"classes/httptermoptions.html#compressionsupported","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":14,"kind":1024,"name":"crlPaths","url":"classes/httptermoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":15,"kind":1024,"name":"crlValues","url":"classes/httptermoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":16,"kind":1024,"name":"decoderInitialBufferSize","url":"classes/httptermoptions.html#decoderinitialbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":17,"kind":1024,"name":"decompressionSupported","url":"classes/httptermoptions.html#decompressionsupported","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":18,"kind":1024,"name":"enabledCipherSuites","url":"classes/httptermoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":19,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/httptermoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":20,"kind":1024,"name":"handle100ContinueAutomatically","url":"classes/httptermoptions.html#handle100continueautomatically","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":21,"kind":1024,"name":"host","url":"classes/httptermoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":22,"kind":1024,"name":"http2ConnectionWindowSize","url":"classes/httptermoptions.html#http2connectionwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":23,"kind":1024,"name":"idleTimeout","url":"classes/httptermoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":24,"kind":1024,"name":"initialSettings","url":"classes/httptermoptions.html#initialsettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":25,"kind":1024,"name":"intputrc","url":"classes/httptermoptions.html#intputrc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":26,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/httptermoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":27,"kind":1024,"name":"keyStoreOptions","url":"classes/httptermoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":28,"kind":1024,"name":"logActivity","url":"classes/httptermoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":29,"kind":1024,"name":"maxChunkSize","url":"classes/httptermoptions.html#maxchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":30,"kind":1024,"name":"maxHeaderSize","url":"classes/httptermoptions.html#maxheadersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":31,"kind":1024,"name":"maxInitialLineLength","url":"classes/httptermoptions.html#maxinitiallinelength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":32,"kind":1024,"name":"maxWebsocketFrameSize","url":"classes/httptermoptions.html#maxwebsocketframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":33,"kind":1024,"name":"maxWebsocketMessageSize","url":"classes/httptermoptions.html#maxwebsocketmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":34,"kind":1024,"name":"openSslEngineOptions","url":"classes/httptermoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":35,"kind":1024,"name":"pemKeyCertOptions","url":"classes/httptermoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":36,"kind":1024,"name":"pemTrustOptions","url":"classes/httptermoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":37,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/httptermoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":38,"kind":1024,"name":"pfxTrustOptions","url":"classes/httptermoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":39,"kind":1024,"name":"port","url":"classes/httptermoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":40,"kind":1024,"name":"receiveBufferSize","url":"classes/httptermoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":41,"kind":1024,"name":"reuseAddress","url":"classes/httptermoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":42,"kind":1024,"name":"reusePort","url":"classes/httptermoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":43,"kind":1024,"name":"sendBufferSize","url":"classes/httptermoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":44,"kind":1024,"name":"shellHtmlResource","url":"classes/httptermoptions.html#shellhtmlresource","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":45,"kind":1024,"name":"sni","url":"classes/httptermoptions.html#sni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":46,"kind":1024,"name":"soLinger","url":"classes/httptermoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":47,"kind":1024,"name":"sockJSHandlerOptions","url":"classes/httptermoptions.html#sockjshandleroptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":48,"kind":1024,"name":"sockJSPath","url":"classes/httptermoptions.html#sockjspath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":49,"kind":1024,"name":"ssl","url":"classes/httptermoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":50,"kind":1024,"name":"tcpCork","url":"classes/httptermoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":51,"kind":1024,"name":"tcpFastOpen","url":"classes/httptermoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":52,"kind":1024,"name":"tcpKeepAlive","url":"classes/httptermoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":53,"kind":1024,"name":"tcpNoDelay","url":"classes/httptermoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":54,"kind":1024,"name":"tcpQuickAck","url":"classes/httptermoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":55,"kind":1024,"name":"termJsResource","url":"classes/httptermoptions.html#termjsresource","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":56,"kind":1024,"name":"trafficClass","url":"classes/httptermoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":57,"kind":1024,"name":"trustStoreOptions","url":"classes/httptermoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":58,"kind":1024,"name":"useAlpn","url":"classes/httptermoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":59,"kind":1024,"name":"usePooledBuffers","url":"classes/httptermoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":60,"kind":1024,"name":"vertsShellJsResource","url":"classes/httptermoptions.html#vertsshelljsresource","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":61,"kind":1024,"name":"websocketSubProtocols","url":"classes/httptermoptions.html#websocketsubprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":62,"kind":128,"name":"SSHTermOptions","url":"classes/sshtermoptions.html","classes":"tsd-kind-class"},{"id":63,"kind":1024,"name":"defaultCharset","url":"classes/sshtermoptions.html#defaultcharset","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":64,"kind":1024,"name":"host","url":"classes/sshtermoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":65,"kind":1024,"name":"intputrc","url":"classes/sshtermoptions.html#intputrc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":66,"kind":1024,"name":"keyPairOptions","url":"classes/sshtermoptions.html#keypairoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":67,"kind":1024,"name":"pemKeyPairOptions","url":"classes/sshtermoptions.html#pemkeypairoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":68,"kind":1024,"name":"pfxKeyPairOptions","url":"classes/sshtermoptions.html#pfxkeypairoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":69,"kind":1024,"name":"port","url":"classes/sshtermoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":70,"kind":128,"name":"ShellServerOptions","url":"classes/shellserveroptions.html","classes":"tsd-kind-class"},{"id":71,"kind":1024,"name":"reaperInterval","url":"classes/shellserveroptions.html#reaperinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":72,"kind":1024,"name":"sessionTimeout","url":"classes/shellserveroptions.html#sessiontimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":73,"kind":1024,"name":"welcomeMessage","url":"classes/shellserveroptions.html#welcomemessage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":74,"kind":128,"name":"ShellServiceOptions","url":"classes/shellserviceoptions.html","classes":"tsd-kind-class"},{"id":75,"kind":1024,"name":"httpOptions","url":"classes/shellserviceoptions.html#httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":76,"kind":1024,"name":"reaperInterval","url":"classes/shellserviceoptions.html#reaperinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":77,"kind":1024,"name":"sessionTimeout","url":"classes/shellserviceoptions.html#sessiontimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":78,"kind":1024,"name":"sshOptions","url":"classes/shellserviceoptions.html#sshoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":79,"kind":1024,"name":"telnetOptions","url":"classes/shellserviceoptions.html#telnetoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":80,"kind":1024,"name":"welcomeMessage","url":"classes/shellserviceoptions.html#welcomemessage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":81,"kind":128,"name":"TelnetTermOptions","url":"classes/telnettermoptions.html","classes":"tsd-kind-class"},{"id":82,"kind":1024,"name":"acceptBacklog","url":"classes/telnettermoptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":83,"kind":1024,"name":"charset","url":"classes/telnettermoptions.html#charset","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":84,"kind":1024,"name":"clientAuth","url":"classes/telnettermoptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":85,"kind":1024,"name":"clientAuthRequired","url":"classes/telnettermoptions.html#clientauthrequired","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":86,"kind":1024,"name":"crlPaths","url":"classes/telnettermoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":87,"kind":1024,"name":"crlValues","url":"classes/telnettermoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":88,"kind":1024,"name":"enabledCipherSuites","url":"classes/telnettermoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":89,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/telnettermoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":90,"kind":1024,"name":"host","url":"classes/telnettermoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":91,"kind":1024,"name":"idleTimeout","url":"classes/telnettermoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":92,"kind":1024,"name":"inBinary","url":"classes/telnettermoptions.html#inbinary","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":93,"kind":1024,"name":"intputrc","url":"classes/telnettermoptions.html#intputrc","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":94,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/telnettermoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":95,"kind":1024,"name":"keyStoreOptions","url":"classes/telnettermoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":96,"kind":1024,"name":"logActivity","url":"classes/telnettermoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":97,"kind":1024,"name":"openSslEngineOptions","url":"classes/telnettermoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":98,"kind":1024,"name":"outBinary","url":"classes/telnettermoptions.html#outbinary","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":99,"kind":1024,"name":"pemKeyCertOptions","url":"classes/telnettermoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":100,"kind":1024,"name":"pemTrustOptions","url":"classes/telnettermoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":101,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/telnettermoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":102,"kind":1024,"name":"pfxTrustOptions","url":"classes/telnettermoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":103,"kind":1024,"name":"port","url":"classes/telnettermoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":104,"kind":1024,"name":"receiveBufferSize","url":"classes/telnettermoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":105,"kind":1024,"name":"reuseAddress","url":"classes/telnettermoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":106,"kind":1024,"name":"reusePort","url":"classes/telnettermoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":107,"kind":1024,"name":"sendBufferSize","url":"classes/telnettermoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":108,"kind":1024,"name":"sni","url":"classes/telnettermoptions.html#sni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":109,"kind":1024,"name":"soLinger","url":"classes/telnettermoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":110,"kind":1024,"name":"ssl","url":"classes/telnettermoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":111,"kind":1024,"name":"tcpCork","url":"classes/telnettermoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":112,"kind":1024,"name":"tcpFastOpen","url":"classes/telnettermoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":113,"kind":1024,"name":"tcpKeepAlive","url":"classes/telnettermoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":114,"kind":1024,"name":"tcpNoDelay","url":"classes/telnettermoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":115,"kind":1024,"name":"tcpQuickAck","url":"classes/telnettermoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":116,"kind":1024,"name":"trafficClass","url":"classes/telnettermoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":117,"kind":1024,"name":"trustStoreOptions","url":"classes/telnettermoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":118,"kind":1024,"name":"useAlpn","url":"classes/telnettermoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":119,"kind":1024,"name":"usePooledBuffers","url":"classes/telnettermoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":120,"kind":128,"name":"CliToken","url":"classes/clitoken.html","classes":"tsd-kind-class"},{"id":121,"kind":2048,"name":"createText","url":"classes/clitoken.html#createtext","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CliToken"},{"id":122,"kind":2048,"name":"createBlank","url":"classes/clitoken.html#createblank","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CliToken"},{"id":123,"kind":2048,"name":"value","url":"classes/clitoken.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":124,"kind":2048,"name":"raw","url":"classes/clitoken.html#raw","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":125,"kind":2048,"name":"isText","url":"classes/clitoken.html#istext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":126,"kind":2048,"name":"isBlank","url":"classes/clitoken.html#isblank","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":127,"kind":2048,"name":"tokenize","url":"classes/clitoken.html#tokenize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CliToken"},{"id":128,"kind":128,"name":"Command","url":"classes/command.html","classes":"tsd-kind-class"},{"id":129,"kind":2048,"name":"name","url":"classes/command.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":130,"kind":2048,"name":"cli","url":"classes/command.html#cli","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":131,"kind":2048,"name":"createProcess","url":"classes/command.html#createprocess","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":132,"kind":2048,"name":"complete","url":"classes/command.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":133,"kind":128,"name":"CommandBuilder","url":"classes/commandbuilder.html","classes":"tsd-kind-class"},{"id":134,"kind":2048,"name":"command","url":"classes/commandbuilder.html#command","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandBuilder"},{"id":135,"kind":2048,"name":"processHandler","url":"classes/commandbuilder.html#processhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandBuilder"},{"id":136,"kind":2048,"name":"completionHandler","url":"classes/commandbuilder.html#completionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandBuilder"},{"id":137,"kind":2048,"name":"build","url":"classes/commandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandBuilder"},{"id":138,"kind":128,"name":"CommandProcess","url":"classes/commandprocess.html","classes":"tsd-kind-class"},{"id":139,"kind":2048,"name":"vertx","url":"classes/commandprocess.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":140,"kind":2048,"name":"argsTokens","url":"classes/commandprocess.html#argstokens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":141,"kind":2048,"name":"args","url":"classes/commandprocess.html#args","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":142,"kind":2048,"name":"commandLine","url":"classes/commandprocess.html#commandline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":143,"kind":2048,"name":"session","url":"classes/commandprocess.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":144,"kind":2048,"name":"isForeground","url":"classes/commandprocess.html#isforeground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":145,"kind":2048,"name":"stdinHandler","url":"classes/commandprocess.html#stdinhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":146,"kind":2048,"name":"interruptHandler","url":"classes/commandprocess.html#interrupthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":147,"kind":2048,"name":"suspendHandler","url":"classes/commandprocess.html#suspendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":148,"kind":2048,"name":"resumeHandler","url":"classes/commandprocess.html#resumehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":149,"kind":2048,"name":"endHandler","url":"classes/commandprocess.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":150,"kind":2048,"name":"write","url":"classes/commandprocess.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":151,"kind":2048,"name":"backgroundHandler","url":"classes/commandprocess.html#backgroundhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":152,"kind":2048,"name":"foregroundHandler","url":"classes/commandprocess.html#foregroundhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":153,"kind":2048,"name":"resizehandler","url":"classes/commandprocess.html#resizehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":154,"kind":2048,"name":"end","url":"classes/commandprocess.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":155,"kind":128,"name":"CommandRegistry","url":"classes/commandregistry.html","classes":"tsd-kind-class"},{"id":156,"kind":2048,"name":"getShared","url":"classes/commandregistry.html#getshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandRegistry"},{"id":157,"kind":2048,"name":"create","url":"classes/commandregistry.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandRegistry"},{"id":158,"kind":2048,"name":"registerCommand","url":"classes/commandregistry.html#registercommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandRegistry"},{"id":159,"kind":2048,"name":"registerCommands","url":"classes/commandregistry.html#registercommands","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandRegistry"},{"id":160,"kind":2048,"name":"unregisterCommand","url":"classes/commandregistry.html#unregistercommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandRegistry"},{"id":161,"kind":128,"name":"CommandResolver","url":"classes/commandresolver.html","classes":"tsd-kind-class"},{"id":162,"kind":2048,"name":"baseCommands","url":"classes/commandresolver.html#basecommands","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandResolver"},{"id":163,"kind":2048,"name":"commands","url":"classes/commandresolver.html#commands","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandResolver"},{"id":164,"kind":2048,"name":"getCommand","url":"classes/commandresolver.html#getcommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandResolver"},{"id":165,"kind":128,"name":"Completion","url":"classes/completion.html","classes":"tsd-kind-class"},{"id":166,"kind":2048,"name":"vertx","url":"classes/completion.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":167,"kind":2048,"name":"session","url":"classes/completion.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":168,"kind":2048,"name":"rawLine","url":"classes/completion.html#rawline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":169,"kind":2048,"name":"lineTokens","url":"classes/completion.html#linetokens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":170,"kind":2048,"name":"complete","url":"classes/completion.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":171,"kind":128,"name":"Job","url":"classes/job.html","classes":"tsd-kind-class"},{"id":172,"kind":2048,"name":"id","url":"classes/job.html#id","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":173,"kind":2048,"name":"status","url":"classes/job.html#status","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":174,"kind":2048,"name":"lastStopped","url":"classes/job.html#laststopped","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":175,"kind":2048,"name":"line","url":"classes/job.html#line","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":176,"kind":2048,"name":"setTty","url":"classes/job.html#settty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":177,"kind":2048,"name":"setSession","url":"classes/job.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":178,"kind":2048,"name":"statusUpdateHandler","url":"classes/job.html#statusupdatehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":179,"kind":2048,"name":"run","url":"classes/job.html#run","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":180,"kind":2048,"name":"interrupt","url":"classes/job.html#interrupt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":181,"kind":2048,"name":"resume","url":"classes/job.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":182,"kind":2048,"name":"toBackground","url":"classes/job.html#tobackground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":183,"kind":2048,"name":"toForeground","url":"classes/job.html#toforeground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":184,"kind":2048,"name":"suspend","url":"classes/job.html#suspend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":185,"kind":2048,"name":"terminate","url":"classes/job.html#terminate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":186,"kind":2048,"name":"process","url":"classes/job.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":187,"kind":128,"name":"JobController","url":"classes/jobcontroller.html","classes":"tsd-kind-class"},{"id":188,"kind":2048,"name":"foregroundJob","url":"classes/jobcontroller.html#foregroundjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":189,"kind":2048,"name":"jobs","url":"classes/jobcontroller.html#jobs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":190,"kind":2048,"name":"getJob","url":"classes/jobcontroller.html#getjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":191,"kind":2048,"name":"createJob","url":"classes/jobcontroller.html#createjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":192,"kind":2048,"name":"close","url":"classes/jobcontroller.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":193,"kind":128,"name":"Process","url":"classes/process.html","classes":"tsd-kind-class"},{"id":194,"kind":2048,"name":"status","url":"classes/process.html#status","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":195,"kind":2048,"name":"exitCode","url":"classes/process.html#exitcode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":196,"kind":2048,"name":"setTty","url":"classes/process.html#settty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":197,"kind":2048,"name":"getTty","url":"classes/process.html#gettty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":198,"kind":2048,"name":"setSession","url":"classes/process.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":199,"kind":2048,"name":"getSession","url":"classes/process.html#getsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":200,"kind":2048,"name":"terminatedHandler","url":"classes/process.html#terminatedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":201,"kind":2048,"name":"run","url":"classes/process.html#run","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":202,"kind":2048,"name":"interrupt","url":"classes/process.html#interrupt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":203,"kind":2048,"name":"resume","url":"classes/process.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":204,"kind":2048,"name":"suspend","url":"classes/process.html#suspend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":205,"kind":2048,"name":"terminate","url":"classes/process.html#terminate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":206,"kind":2048,"name":"toBackground","url":"classes/process.html#tobackground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":207,"kind":2048,"name":"toForeground","url":"classes/process.html#toforeground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":208,"kind":128,"name":"Pty","url":"classes/pty.html","classes":"tsd-kind-class"},{"id":209,"kind":2048,"name":"create","url":"classes/pty.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Pty"},{"id":210,"kind":2048,"name":"stdoutHandler","url":"classes/pty.html#stdouthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":211,"kind":2048,"name":"write","url":"classes/pty.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":212,"kind":2048,"name":"setSize","url":"classes/pty.html#setsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":213,"kind":2048,"name":"slave","url":"classes/pty.html#slave","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":214,"kind":128,"name":"Session","url":"classes/session.html","classes":"tsd-kind-class"},{"id":215,"kind":2048,"name":"create","url":"classes/session.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Session"},{"id":216,"kind":2048,"name":"put","url":"classes/session.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":217,"kind":2048,"name":"get","url":"classes/session.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":218,"kind":2048,"name":"remove","url":"classes/session.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":219,"kind":128,"name":"Shell","url":"classes/shell.html","classes":"tsd-kind-class"},{"id":220,"kind":2048,"name":"createJob","url":"classes/shell.html#createjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":221,"kind":2048,"name":"jobController","url":"classes/shell.html#jobcontroller","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":222,"kind":2048,"name":"session","url":"classes/shell.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":223,"kind":2048,"name":"close","url":"classes/shell.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":224,"kind":128,"name":"ShellServer","url":"classes/shellserver.html","classes":"tsd-kind-class"},{"id":225,"kind":2048,"name":"create","url":"classes/shellserver.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShellServer"},{"id":226,"kind":2048,"name":"registerCommandResolver","url":"classes/shellserver.html#registercommandresolver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":227,"kind":2048,"name":"registerTermServer","url":"classes/shellserver.html#registertermserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":228,"kind":2048,"name":"createShell","url":"classes/shellserver.html#createshell","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":229,"kind":2048,"name":"listen","url":"classes/shellserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":230,"kind":2048,"name":"close","url":"classes/shellserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":231,"kind":128,"name":"ShellService","url":"classes/shellservice.html","classes":"tsd-kind-class"},{"id":232,"kind":2048,"name":"create","url":"classes/shellservice.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShellService"},{"id":233,"kind":2048,"name":"start","url":"classes/shellservice.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellService"},{"id":234,"kind":2048,"name":"server","url":"classes/shellservice.html#server","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellService"},{"id":235,"kind":2048,"name":"stop","url":"classes/shellservice.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellService"},{"id":236,"kind":128,"name":"SignalHandler","url":"classes/signalhandler.html","classes":"tsd-kind-class"},{"id":237,"kind":2048,"name":"deliver","url":"classes/signalhandler.html#deliver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SignalHandler"},{"id":238,"kind":128,"name":"SockJSTermHandler","url":"classes/sockjstermhandler.html","classes":"tsd-kind-class"},{"id":239,"kind":2048,"name":"handle","url":"classes/sockjstermhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SockJSTermHandler"},{"id":240,"kind":2048,"name":"create","url":"classes/sockjstermhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SockJSTermHandler"},{"id":241,"kind":2048,"name":"termHandler","url":"classes/sockjstermhandler.html#termhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SockJSTermHandler"},{"id":242,"kind":128,"name":"Term","url":"classes/term.html","classes":"tsd-kind-class"},{"id":243,"kind":2048,"name":"resizehandler","url":"classes/term.html#resizehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":244,"kind":2048,"name":"stdinHandler","url":"classes/term.html#stdinhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":245,"kind":2048,"name":"write","url":"classes/term.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":246,"kind":2048,"name":"lastAccessedTime","url":"classes/term.html#lastaccessedtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":247,"kind":2048,"name":"echo","url":"classes/term.html#echo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":248,"kind":2048,"name":"setSession","url":"classes/term.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":249,"kind":2048,"name":"interruptHandler","url":"classes/term.html#interrupthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":250,"kind":2048,"name":"suspendHandler","url":"classes/term.html#suspendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":251,"kind":2048,"name":"readline","url":"classes/term.html#readline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":252,"kind":2048,"name":"closeHandler","url":"classes/term.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":253,"kind":2048,"name":"close","url":"classes/term.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":254,"kind":128,"name":"TermServer","url":"classes/termserver.html","classes":"tsd-kind-class"},{"id":255,"kind":2048,"name":"createSSHTermServer","url":"classes/termserver.html#createsshtermserver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TermServer"},{"id":256,"kind":2048,"name":"createTelnetTermServer","url":"classes/termserver.html#createtelnettermserver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TermServer"},{"id":257,"kind":2048,"name":"createHttpTermServer","url":"classes/termserver.html#createhttptermserver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TermServer"},{"id":258,"kind":2048,"name":"termHandler","url":"classes/termserver.html#termhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":259,"kind":2048,"name":"authProvider","url":"classes/termserver.html#authprovider","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":260,"kind":2048,"name":"listen","url":"classes/termserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":261,"kind":2048,"name":"actualPort","url":"classes/termserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":262,"kind":2048,"name":"close","url":"classes/termserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":263,"kind":128,"name":"Tty","url":"classes/tty.html","classes":"tsd-kind-class"},{"id":264,"kind":2048,"name":"type","url":"classes/tty.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":265,"kind":2048,"name":"width","url":"classes/tty.html#width","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":266,"kind":2048,"name":"height","url":"classes/tty.html#height","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":267,"kind":2048,"name":"stdinHandler","url":"classes/tty.html#stdinhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":268,"kind":2048,"name":"write","url":"classes/tty.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":269,"kind":2048,"name":"resizehandler","url":"classes/tty.html#resizehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"ExecStatus","url":"enums/execstatus.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"READY","url":"enums/execstatus.html#ready","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":2,"kind":16,"name":"RUNNING","url":"enums/execstatus.html#running","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":3,"kind":16,"name":"STOPPED","url":"enums/execstatus.html#stopped","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":4,"kind":16,"name":"TERMINATED","url":"enums/execstatus.html#terminated","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ExecStatus"},{"id":5,"kind":128,"name":"HttpTermOptions","url":"classes/httptermoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":512,"name":"constructor","url":"classes/httptermoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":7,"kind":2048,"name":"getAcceptBacklog","url":"classes/httptermoptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":8,"kind":2048,"name":"setAcceptBacklog","url":"classes/httptermoptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":9,"kind":2048,"name":"isAcceptUnmaskedFrames","url":"classes/httptermoptions.html#isacceptunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":10,"kind":2048,"name":"setAcceptUnmaskedFrames","url":"classes/httptermoptions.html#setacceptunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":11,"kind":2048,"name":"getAlpnVersions","url":"classes/httptermoptions.html#getalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":12,"kind":2048,"name":"setAlpnVersions","url":"classes/httptermoptions.html#setalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":13,"kind":2048,"name":"getAuthOptions","url":"classes/httptermoptions.html#getauthoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":14,"kind":2048,"name":"getCharset","url":"classes/httptermoptions.html#getcharset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":15,"kind":2048,"name":"setCharset","url":"classes/httptermoptions.html#setcharset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":16,"kind":2048,"name":"getClientAuth","url":"classes/httptermoptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":17,"kind":2048,"name":"setClientAuth","url":"classes/httptermoptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":18,"kind":2048,"name":"isClientAuthRequired","url":"classes/httptermoptions.html#isclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":19,"kind":2048,"name":"setClientAuthRequired","url":"classes/httptermoptions.html#setclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":20,"kind":2048,"name":"getCompressionLevel","url":"classes/httptermoptions.html#getcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":21,"kind":2048,"name":"setCompressionLevel","url":"classes/httptermoptions.html#setcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":22,"kind":2048,"name":"isCompressionSupported","url":"classes/httptermoptions.html#iscompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":23,"kind":2048,"name":"setCompressionSupported","url":"classes/httptermoptions.html#setcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":24,"kind":2048,"name":"getCrlPaths","url":"classes/httptermoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":25,"kind":2048,"name":"addCrlPath","url":"classes/httptermoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":26,"kind":2048,"name":"getCrlValues","url":"classes/httptermoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":27,"kind":2048,"name":"addCrlValue","url":"classes/httptermoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":28,"kind":2048,"name":"getDecoderInitialBufferSize","url":"classes/httptermoptions.html#getdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":29,"kind":2048,"name":"setDecoderInitialBufferSize","url":"classes/httptermoptions.html#setdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":30,"kind":2048,"name":"isDecompressionSupported","url":"classes/httptermoptions.html#isdecompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":31,"kind":2048,"name":"setDecompressionSupported","url":"classes/httptermoptions.html#setdecompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":32,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/httptermoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":33,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/httptermoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":34,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/httptermoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":35,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/httptermoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":36,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/httptermoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":37,"kind":2048,"name":"isHandle100ContinueAutomatically","url":"classes/httptermoptions.html#ishandle100continueautomatically","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":38,"kind":2048,"name":"setHandle100ContinueAutomatically","url":"classes/httptermoptions.html#sethandle100continueautomatically","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":39,"kind":2048,"name":"getHost","url":"classes/httptermoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":40,"kind":2048,"name":"setHost","url":"classes/httptermoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":41,"kind":2048,"name":"getHttp2ConnectionWindowSize","url":"classes/httptermoptions.html#gethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":42,"kind":2048,"name":"setHttp2ConnectionWindowSize","url":"classes/httptermoptions.html#sethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":43,"kind":2048,"name":"getIdleTimeout","url":"classes/httptermoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":44,"kind":2048,"name":"setIdleTimeout","url":"classes/httptermoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":45,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/httptermoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":46,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/httptermoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":47,"kind":2048,"name":"getInitialSettings","url":"classes/httptermoptions.html#getinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":48,"kind":2048,"name":"setInitialSettings","url":"classes/httptermoptions.html#setinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":49,"kind":2048,"name":"getIntputrc","url":"classes/httptermoptions.html#getintputrc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":50,"kind":2048,"name":"setIntputrc","url":"classes/httptermoptions.html#setintputrc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":51,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/httptermoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":52,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/httptermoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":53,"kind":2048,"name":"getKeyStoreOptions","url":"classes/httptermoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":54,"kind":2048,"name":"setKeyStoreOptions","url":"classes/httptermoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":55,"kind":2048,"name":"getLogActivity","url":"classes/httptermoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":56,"kind":2048,"name":"setLogActivity","url":"classes/httptermoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":57,"kind":2048,"name":"getMaxChunkSize","url":"classes/httptermoptions.html#getmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":58,"kind":2048,"name":"setMaxChunkSize","url":"classes/httptermoptions.html#setmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":59,"kind":2048,"name":"getMaxHeaderSize","url":"classes/httptermoptions.html#getmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":60,"kind":2048,"name":"setMaxHeaderSize","url":"classes/httptermoptions.html#setmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":61,"kind":2048,"name":"getMaxInitialLineLength","url":"classes/httptermoptions.html#getmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":62,"kind":2048,"name":"setMaxInitialLineLength","url":"classes/httptermoptions.html#setmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":63,"kind":2048,"name":"getMaxWebsocketFrameSize","url":"classes/httptermoptions.html#getmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":64,"kind":2048,"name":"setMaxWebsocketFrameSize","url":"classes/httptermoptions.html#setmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":65,"kind":2048,"name":"getMaxWebsocketMessageSize","url":"classes/httptermoptions.html#getmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":66,"kind":2048,"name":"setMaxWebsocketMessageSize","url":"classes/httptermoptions.html#setmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":67,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/httptermoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":68,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/httptermoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":69,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/httptermoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":70,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/httptermoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":71,"kind":2048,"name":"getPemTrustOptions","url":"classes/httptermoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":72,"kind":2048,"name":"setPemTrustOptions","url":"classes/httptermoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":73,"kind":2048,"name":"perFrameWebsocketCompressionSupported","url":"classes/httptermoptions.html#perframewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":74,"kind":2048,"name":"setPerFrameWebsocketCompressionSupported","url":"classes/httptermoptions.html#setperframewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":75,"kind":2048,"name":"perMessageWebsocketCompressionSupported","url":"classes/httptermoptions.html#permessagewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":76,"kind":2048,"name":"setPerMessageWebsocketCompressionSupported","url":"classes/httptermoptions.html#setpermessagewebsocketcompressionsupported","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":77,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/httptermoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":78,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/httptermoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":79,"kind":2048,"name":"getPfxTrustOptions","url":"classes/httptermoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":80,"kind":2048,"name":"setPfxTrustOptions","url":"classes/httptermoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":81,"kind":2048,"name":"getPort","url":"classes/httptermoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":82,"kind":2048,"name":"setPort","url":"classes/httptermoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":83,"kind":2048,"name":"getReceiveBufferSize","url":"classes/httptermoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":84,"kind":2048,"name":"setReceiveBufferSize","url":"classes/httptermoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":85,"kind":2048,"name":"isReuseAddress","url":"classes/httptermoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":86,"kind":2048,"name":"setReuseAddress","url":"classes/httptermoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":87,"kind":2048,"name":"isReusePort","url":"classes/httptermoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":88,"kind":2048,"name":"setReusePort","url":"classes/httptermoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":89,"kind":2048,"name":"getSendBufferSize","url":"classes/httptermoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":90,"kind":2048,"name":"setSendBufferSize","url":"classes/httptermoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":91,"kind":2048,"name":"getShellHtmlResource","url":"classes/httptermoptions.html#getshellhtmlresource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":92,"kind":2048,"name":"setShellHtmlResource","url":"classes/httptermoptions.html#setshellhtmlresource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":93,"kind":2048,"name":"isSni","url":"classes/httptermoptions.html#issni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":94,"kind":2048,"name":"setSni","url":"classes/httptermoptions.html#setsni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":95,"kind":2048,"name":"getSoLinger","url":"classes/httptermoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":96,"kind":2048,"name":"setSoLinger","url":"classes/httptermoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":97,"kind":2048,"name":"getSockJSHandlerOptions","url":"classes/httptermoptions.html#getsockjshandleroptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":98,"kind":2048,"name":"setSockJSHandlerOptions","url":"classes/httptermoptions.html#setsockjshandleroptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":99,"kind":2048,"name":"getSockJSPath","url":"classes/httptermoptions.html#getsockjspath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":100,"kind":2048,"name":"setSockJSPath","url":"classes/httptermoptions.html#setsockjspath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":101,"kind":2048,"name":"isSsl","url":"classes/httptermoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":102,"kind":2048,"name":"setSsl","url":"classes/httptermoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":103,"kind":2048,"name":"isTcpCork","url":"classes/httptermoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":104,"kind":2048,"name":"setTcpCork","url":"classes/httptermoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":105,"kind":2048,"name":"isTcpFastOpen","url":"classes/httptermoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":106,"kind":2048,"name":"setTcpFastOpen","url":"classes/httptermoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":107,"kind":2048,"name":"isTcpKeepAlive","url":"classes/httptermoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":108,"kind":2048,"name":"setTcpKeepAlive","url":"classes/httptermoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":109,"kind":2048,"name":"isTcpNoDelay","url":"classes/httptermoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":110,"kind":2048,"name":"setTcpNoDelay","url":"classes/httptermoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":111,"kind":2048,"name":"isTcpQuickAck","url":"classes/httptermoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":112,"kind":2048,"name":"setTcpQuickAck","url":"classes/httptermoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":113,"kind":2048,"name":"getTermJsResource","url":"classes/httptermoptions.html#gettermjsresource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":114,"kind":2048,"name":"setTermJsResource","url":"classes/httptermoptions.html#settermjsresource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":115,"kind":2048,"name":"getTrafficClass","url":"classes/httptermoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":116,"kind":2048,"name":"setTrafficClass","url":"classes/httptermoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":117,"kind":2048,"name":"getTrustStoreOptions","url":"classes/httptermoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":118,"kind":2048,"name":"setTrustStoreOptions","url":"classes/httptermoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":119,"kind":2048,"name":"isUseAlpn","url":"classes/httptermoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":120,"kind":2048,"name":"setUseAlpn","url":"classes/httptermoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":121,"kind":2048,"name":"isUsePooledBuffers","url":"classes/httptermoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":122,"kind":2048,"name":"setUsePooledBuffers","url":"classes/httptermoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":123,"kind":2048,"name":"getVertsShellJsResource","url":"classes/httptermoptions.html#getvertsshelljsresource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":124,"kind":2048,"name":"setVertsShellJsResource","url":"classes/httptermoptions.html#setvertsshelljsresource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":125,"kind":2048,"name":"getWebsocketAllowServerNoContext","url":"classes/httptermoptions.html#getwebsocketallowservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":126,"kind":2048,"name":"setWebsocketAllowServerNoContext","url":"classes/httptermoptions.html#setwebsocketallowservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":127,"kind":2048,"name":"websocketCompressionLevel","url":"classes/httptermoptions.html#websocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":128,"kind":2048,"name":"setWebsocketCompressionLevel","url":"classes/httptermoptions.html#setwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":129,"kind":2048,"name":"getWebsocketPreferredClientNoContext","url":"classes/httptermoptions.html#getwebsocketpreferredclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":130,"kind":2048,"name":"setWebsocketPreferredClientNoContext","url":"classes/httptermoptions.html#setwebsocketpreferredclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":131,"kind":2048,"name":"getWebsocketSubProtocols","url":"classes/httptermoptions.html#getwebsocketsubprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":132,"kind":2048,"name":"setWebsocketSubProtocols","url":"classes/httptermoptions.html#setwebsocketsubprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpTermOptions"},{"id":133,"kind":128,"name":"SSHTermOptions","url":"classes/sshtermoptions.html","classes":"tsd-kind-class"},{"id":134,"kind":512,"name":"constructor","url":"classes/sshtermoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":135,"kind":2048,"name":"getAuthOptions","url":"classes/sshtermoptions.html#getauthoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":136,"kind":2048,"name":"getDefaultCharset","url":"classes/sshtermoptions.html#getdefaultcharset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":137,"kind":2048,"name":"setDefaultCharset","url":"classes/sshtermoptions.html#setdefaultcharset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":138,"kind":2048,"name":"getHost","url":"classes/sshtermoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":139,"kind":2048,"name":"setHost","url":"classes/sshtermoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":140,"kind":2048,"name":"getIntputrc","url":"classes/sshtermoptions.html#getintputrc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":141,"kind":2048,"name":"setIntputrc","url":"classes/sshtermoptions.html#setintputrc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":142,"kind":2048,"name":"keyPairOptions","url":"classes/sshtermoptions.html#keypairoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":143,"kind":2048,"name":"setKeyPairOptions","url":"classes/sshtermoptions.html#setkeypairoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":144,"kind":2048,"name":"pemKeyPairOptions","url":"classes/sshtermoptions.html#pemkeypairoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":145,"kind":2048,"name":"setPemKeyPairOptions","url":"classes/sshtermoptions.html#setpemkeypairoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":146,"kind":2048,"name":"pfxKeyPairOptions","url":"classes/sshtermoptions.html#pfxkeypairoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":147,"kind":2048,"name":"setPfxKeyPairOptions","url":"classes/sshtermoptions.html#setpfxkeypairoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":148,"kind":2048,"name":"getPort","url":"classes/sshtermoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":149,"kind":2048,"name":"setPort","url":"classes/sshtermoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SSHTermOptions"},{"id":150,"kind":128,"name":"ShellServerOptions","url":"classes/shellserveroptions.html","classes":"tsd-kind-class"},{"id":151,"kind":512,"name":"constructor","url":"classes/shellserveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":152,"kind":2048,"name":"getReaperInterval","url":"classes/shellserveroptions.html#getreaperinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":153,"kind":2048,"name":"setReaperInterval","url":"classes/shellserveroptions.html#setreaperinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":154,"kind":2048,"name":"getSessionTimeout","url":"classes/shellserveroptions.html#getsessiontimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":155,"kind":2048,"name":"setSessionTimeout","url":"classes/shellserveroptions.html#setsessiontimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":156,"kind":2048,"name":"getWelcomeMessage","url":"classes/shellserveroptions.html#getwelcomemessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":157,"kind":2048,"name":"setWelcomeMessage","url":"classes/shellserveroptions.html#setwelcomemessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServerOptions"},{"id":158,"kind":128,"name":"ShellServiceOptions","url":"classes/shellserviceoptions.html","classes":"tsd-kind-class"},{"id":159,"kind":512,"name":"constructor","url":"classes/shellserviceoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":160,"kind":2048,"name":"getHttpOptions","url":"classes/shellserviceoptions.html#gethttpoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":161,"kind":2048,"name":"setHttpOptions","url":"classes/shellserviceoptions.html#sethttpoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":162,"kind":2048,"name":"getReaperInterval","url":"classes/shellserviceoptions.html#getreaperinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":163,"kind":2048,"name":"setReaperInterval","url":"classes/shellserviceoptions.html#setreaperinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":164,"kind":2048,"name":"getSessionTimeout","url":"classes/shellserviceoptions.html#getsessiontimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":165,"kind":2048,"name":"setSessionTimeout","url":"classes/shellserviceoptions.html#setsessiontimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":166,"kind":2048,"name":"getSSHOptions","url":"classes/shellserviceoptions.html#getsshoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":167,"kind":2048,"name":"setSSHOptions","url":"classes/shellserviceoptions.html#setsshoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":168,"kind":2048,"name":"getTelnetOptions","url":"classes/shellserviceoptions.html#gettelnetoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":169,"kind":2048,"name":"setTelnetOptions","url":"classes/shellserviceoptions.html#settelnetoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":170,"kind":2048,"name":"getWelcomeMessage","url":"classes/shellserviceoptions.html#getwelcomemessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":171,"kind":2048,"name":"setWelcomeMessage","url":"classes/shellserviceoptions.html#setwelcomemessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServiceOptions"},{"id":172,"kind":128,"name":"TelnetTermOptions","url":"classes/telnettermoptions.html","classes":"tsd-kind-class"},{"id":173,"kind":512,"name":"constructor","url":"classes/telnettermoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":174,"kind":2048,"name":"getAcceptBacklog","url":"classes/telnettermoptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":175,"kind":2048,"name":"setAcceptBacklog","url":"classes/telnettermoptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":176,"kind":2048,"name":"getCharset","url":"classes/telnettermoptions.html#getcharset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":177,"kind":2048,"name":"setCharset","url":"classes/telnettermoptions.html#setcharset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":178,"kind":2048,"name":"getClientAuth","url":"classes/telnettermoptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":179,"kind":2048,"name":"setClientAuth","url":"classes/telnettermoptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":180,"kind":2048,"name":"isClientAuthRequired","url":"classes/telnettermoptions.html#isclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":181,"kind":2048,"name":"setClientAuthRequired","url":"classes/telnettermoptions.html#setclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":182,"kind":2048,"name":"getCrlPaths","url":"classes/telnettermoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":183,"kind":2048,"name":"addCrlPath","url":"classes/telnettermoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":184,"kind":2048,"name":"getCrlValues","url":"classes/telnettermoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":185,"kind":2048,"name":"addCrlValue","url":"classes/telnettermoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":186,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/telnettermoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":187,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/telnettermoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":188,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/telnettermoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":189,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/telnettermoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":190,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/telnettermoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":191,"kind":2048,"name":"getHost","url":"classes/telnettermoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":192,"kind":2048,"name":"setHost","url":"classes/telnettermoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":193,"kind":2048,"name":"getIdleTimeout","url":"classes/telnettermoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":194,"kind":2048,"name":"setIdleTimeout","url":"classes/telnettermoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":195,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/telnettermoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":196,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/telnettermoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":197,"kind":2048,"name":"getInBinary","url":"classes/telnettermoptions.html#getinbinary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":198,"kind":2048,"name":"setInBinary","url":"classes/telnettermoptions.html#setinbinary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":199,"kind":2048,"name":"getIntputrc","url":"classes/telnettermoptions.html#getintputrc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":200,"kind":2048,"name":"setIntputrc","url":"classes/telnettermoptions.html#setintputrc","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":201,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/telnettermoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":202,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/telnettermoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":203,"kind":2048,"name":"getKeyStoreOptions","url":"classes/telnettermoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":204,"kind":2048,"name":"setKeyStoreOptions","url":"classes/telnettermoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":205,"kind":2048,"name":"getLogActivity","url":"classes/telnettermoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":206,"kind":2048,"name":"setLogActivity","url":"classes/telnettermoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":207,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/telnettermoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":208,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/telnettermoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":209,"kind":2048,"name":"getOutBinary","url":"classes/telnettermoptions.html#getoutbinary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":210,"kind":2048,"name":"setOutBinary","url":"classes/telnettermoptions.html#setoutbinary","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":211,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/telnettermoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":212,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/telnettermoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":213,"kind":2048,"name":"getPemTrustOptions","url":"classes/telnettermoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":214,"kind":2048,"name":"setPemTrustOptions","url":"classes/telnettermoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":215,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/telnettermoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":216,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/telnettermoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":217,"kind":2048,"name":"getPfxTrustOptions","url":"classes/telnettermoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":218,"kind":2048,"name":"setPfxTrustOptions","url":"classes/telnettermoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":219,"kind":2048,"name":"getPort","url":"classes/telnettermoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":220,"kind":2048,"name":"setPort","url":"classes/telnettermoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":221,"kind":2048,"name":"getReceiveBufferSize","url":"classes/telnettermoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":222,"kind":2048,"name":"setReceiveBufferSize","url":"classes/telnettermoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":223,"kind":2048,"name":"isReuseAddress","url":"classes/telnettermoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":224,"kind":2048,"name":"setReuseAddress","url":"classes/telnettermoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":225,"kind":2048,"name":"isReusePort","url":"classes/telnettermoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":226,"kind":2048,"name":"setReusePort","url":"classes/telnettermoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":227,"kind":2048,"name":"getSendBufferSize","url":"classes/telnettermoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":228,"kind":2048,"name":"setSendBufferSize","url":"classes/telnettermoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":229,"kind":2048,"name":"isSni","url":"classes/telnettermoptions.html#issni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":230,"kind":2048,"name":"setSni","url":"classes/telnettermoptions.html#setsni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":231,"kind":2048,"name":"getSoLinger","url":"classes/telnettermoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":232,"kind":2048,"name":"setSoLinger","url":"classes/telnettermoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":233,"kind":2048,"name":"isSsl","url":"classes/telnettermoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":234,"kind":2048,"name":"setSsl","url":"classes/telnettermoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":235,"kind":2048,"name":"isTcpCork","url":"classes/telnettermoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":236,"kind":2048,"name":"setTcpCork","url":"classes/telnettermoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":237,"kind":2048,"name":"isTcpFastOpen","url":"classes/telnettermoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":238,"kind":2048,"name":"setTcpFastOpen","url":"classes/telnettermoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":239,"kind":2048,"name":"isTcpKeepAlive","url":"classes/telnettermoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":240,"kind":2048,"name":"setTcpKeepAlive","url":"classes/telnettermoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":241,"kind":2048,"name":"isTcpNoDelay","url":"classes/telnettermoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":242,"kind":2048,"name":"setTcpNoDelay","url":"classes/telnettermoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":243,"kind":2048,"name":"isTcpQuickAck","url":"classes/telnettermoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":244,"kind":2048,"name":"setTcpQuickAck","url":"classes/telnettermoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":245,"kind":2048,"name":"getTrafficClass","url":"classes/telnettermoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":246,"kind":2048,"name":"setTrafficClass","url":"classes/telnettermoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":247,"kind":2048,"name":"getTrustStoreOptions","url":"classes/telnettermoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":248,"kind":2048,"name":"setTrustStoreOptions","url":"classes/telnettermoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":249,"kind":2048,"name":"isUseAlpn","url":"classes/telnettermoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":250,"kind":2048,"name":"setUseAlpn","url":"classes/telnettermoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":251,"kind":2048,"name":"isUsePooledBuffers","url":"classes/telnettermoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":252,"kind":2048,"name":"setUsePooledBuffers","url":"classes/telnettermoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TelnetTermOptions"},{"id":253,"kind":128,"name":"CliToken","url":"classes/clitoken.html","classes":"tsd-kind-class"},{"id":254,"kind":2048,"name":"createText","url":"classes/clitoken.html#createtext","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CliToken"},{"id":255,"kind":2048,"name":"createBlank","url":"classes/clitoken.html#createblank","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CliToken"},{"id":256,"kind":2048,"name":"value","url":"classes/clitoken.html#value","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":257,"kind":2048,"name":"raw","url":"classes/clitoken.html#raw","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":258,"kind":2048,"name":"isText","url":"classes/clitoken.html#istext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":259,"kind":2048,"name":"isBlank","url":"classes/clitoken.html#isblank","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CliToken"},{"id":260,"kind":2048,"name":"tokenize","url":"classes/clitoken.html#tokenize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CliToken"},{"id":261,"kind":128,"name":"Command","url":"classes/command.html","classes":"tsd-kind-class"},{"id":262,"kind":2048,"name":"name","url":"classes/command.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":263,"kind":2048,"name":"cli","url":"classes/command.html#cli","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":264,"kind":2048,"name":"createProcess","url":"classes/command.html#createprocess","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":265,"kind":2048,"name":"complete","url":"classes/command.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Command"},{"id":266,"kind":128,"name":"CommandBuilder","url":"classes/commandbuilder.html","classes":"tsd-kind-class"},{"id":267,"kind":2048,"name":"command","url":"classes/commandbuilder.html#command","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandBuilder"},{"id":268,"kind":2048,"name":"processHandler","url":"classes/commandbuilder.html#processhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandBuilder"},{"id":269,"kind":2048,"name":"completionHandler","url":"classes/commandbuilder.html#completionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandBuilder"},{"id":270,"kind":2048,"name":"build","url":"classes/commandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandBuilder"},{"id":271,"kind":128,"name":"CommandProcess","url":"classes/commandprocess.html","classes":"tsd-kind-class"},{"id":272,"kind":2048,"name":"vertx","url":"classes/commandprocess.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":273,"kind":2048,"name":"argsTokens","url":"classes/commandprocess.html#argstokens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":274,"kind":2048,"name":"args","url":"classes/commandprocess.html#args","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":275,"kind":2048,"name":"commandLine","url":"classes/commandprocess.html#commandline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":276,"kind":2048,"name":"session","url":"classes/commandprocess.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":277,"kind":2048,"name":"isForeground","url":"classes/commandprocess.html#isforeground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":278,"kind":2048,"name":"stdinHandler","url":"classes/commandprocess.html#stdinhandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CommandProcess"},{"id":279,"kind":2048,"name":"interruptHandler","url":"classes/commandprocess.html#interrupthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":280,"kind":2048,"name":"suspendHandler","url":"classes/commandprocess.html#suspendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":281,"kind":2048,"name":"resumeHandler","url":"classes/commandprocess.html#resumehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":282,"kind":2048,"name":"endHandler","url":"classes/commandprocess.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":283,"kind":2048,"name":"write","url":"classes/commandprocess.html#write","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CommandProcess"},{"id":284,"kind":2048,"name":"backgroundHandler","url":"classes/commandprocess.html#backgroundhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":285,"kind":2048,"name":"foregroundHandler","url":"classes/commandprocess.html#foregroundhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":286,"kind":2048,"name":"resizehandler","url":"classes/commandprocess.html#resizehandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"CommandProcess"},{"id":287,"kind":2048,"name":"end","url":"classes/commandprocess.html#end","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandProcess"},{"id":288,"kind":2048,"name":"type","url":"classes/commandprocess.html#type","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CommandProcess"},{"id":289,"kind":2048,"name":"width","url":"classes/commandprocess.html#width","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CommandProcess"},{"id":290,"kind":2048,"name":"height","url":"classes/commandprocess.html#height","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CommandProcess"},{"id":291,"kind":128,"name":"CommandRegistry","url":"classes/commandregistry.html","classes":"tsd-kind-class"},{"id":292,"kind":2048,"name":"getShared","url":"classes/commandregistry.html#getshared","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandRegistry"},{"id":293,"kind":2048,"name":"create","url":"classes/commandregistry.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandRegistry"},{"id":294,"kind":2048,"name":"registerCommand","url":"classes/commandregistry.html#registercommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandRegistry"},{"id":295,"kind":2048,"name":"registerCommands","url":"classes/commandregistry.html#registercommands","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandRegistry"},{"id":296,"kind":2048,"name":"unregisterCommand","url":"classes/commandregistry.html#unregistercommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandRegistry"},{"id":297,"kind":2048,"name":"baseCommands","url":"classes/commandregistry.html#basecommands","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"CommandRegistry"},{"id":298,"kind":2048,"name":"commands","url":"classes/commandregistry.html#commands","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CommandRegistry"},{"id":299,"kind":2048,"name":"getCommand","url":"classes/commandregistry.html#getcommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"CommandRegistry"},{"id":300,"kind":128,"name":"CommandResolver","url":"classes/commandresolver.html","classes":"tsd-kind-class"},{"id":301,"kind":2048,"name":"baseCommands","url":"classes/commandresolver.html#basecommands","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"CommandResolver"},{"id":302,"kind":2048,"name":"commands","url":"classes/commandresolver.html#commands","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandResolver"},{"id":303,"kind":2048,"name":"getCommand","url":"classes/commandresolver.html#getcommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CommandResolver"},{"id":304,"kind":128,"name":"Completion","url":"classes/completion.html","classes":"tsd-kind-class"},{"id":305,"kind":2048,"name":"vertx","url":"classes/completion.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":306,"kind":2048,"name":"session","url":"classes/completion.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":307,"kind":2048,"name":"rawLine","url":"classes/completion.html#rawline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":308,"kind":2048,"name":"lineTokens","url":"classes/completion.html#linetokens","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":309,"kind":2048,"name":"complete","url":"classes/completion.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":310,"kind":128,"name":"Job","url":"classes/job.html","classes":"tsd-kind-class"},{"id":311,"kind":2048,"name":"id","url":"classes/job.html#id","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":312,"kind":2048,"name":"status","url":"classes/job.html#status","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":313,"kind":2048,"name":"lastStopped","url":"classes/job.html#laststopped","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":314,"kind":2048,"name":"line","url":"classes/job.html#line","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":315,"kind":2048,"name":"setTty","url":"classes/job.html#settty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":316,"kind":2048,"name":"setSession","url":"classes/job.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":317,"kind":2048,"name":"statusUpdateHandler","url":"classes/job.html#statusupdatehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":318,"kind":2048,"name":"run","url":"classes/job.html#run","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":319,"kind":2048,"name":"interrupt","url":"classes/job.html#interrupt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":320,"kind":2048,"name":"resume","url":"classes/job.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":321,"kind":2048,"name":"toBackground","url":"classes/job.html#tobackground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":322,"kind":2048,"name":"toForeground","url":"classes/job.html#toforeground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":323,"kind":2048,"name":"suspend","url":"classes/job.html#suspend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":324,"kind":2048,"name":"terminate","url":"classes/job.html#terminate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":325,"kind":2048,"name":"process","url":"classes/job.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Job"},{"id":326,"kind":128,"name":"JobController","url":"classes/jobcontroller.html","classes":"tsd-kind-class"},{"id":327,"kind":2048,"name":"foregroundJob","url":"classes/jobcontroller.html#foregroundjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":328,"kind":2048,"name":"jobs","url":"classes/jobcontroller.html#jobs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":329,"kind":2048,"name":"getJob","url":"classes/jobcontroller.html#getjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":330,"kind":2048,"name":"createJob","url":"classes/jobcontroller.html#createjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":331,"kind":2048,"name":"close","url":"classes/jobcontroller.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"JobController"},{"id":332,"kind":128,"name":"Process","url":"classes/process.html","classes":"tsd-kind-class"},{"id":333,"kind":2048,"name":"status","url":"classes/process.html#status","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":334,"kind":2048,"name":"exitCode","url":"classes/process.html#exitcode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":335,"kind":2048,"name":"setTty","url":"classes/process.html#settty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":336,"kind":2048,"name":"getTty","url":"classes/process.html#gettty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":337,"kind":2048,"name":"setSession","url":"classes/process.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":338,"kind":2048,"name":"getSession","url":"classes/process.html#getsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":339,"kind":2048,"name":"terminatedHandler","url":"classes/process.html#terminatedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":340,"kind":2048,"name":"run","url":"classes/process.html#run","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":341,"kind":2048,"name":"interrupt","url":"classes/process.html#interrupt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":342,"kind":2048,"name":"resume","url":"classes/process.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":343,"kind":2048,"name":"suspend","url":"classes/process.html#suspend","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":344,"kind":2048,"name":"terminate","url":"classes/process.html#terminate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":345,"kind":2048,"name":"toBackground","url":"classes/process.html#tobackground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":346,"kind":2048,"name":"toForeground","url":"classes/process.html#toforeground","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Process"},{"id":347,"kind":128,"name":"Pty","url":"classes/pty.html","classes":"tsd-kind-class"},{"id":348,"kind":2048,"name":"create","url":"classes/pty.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Pty"},{"id":349,"kind":2048,"name":"stdoutHandler","url":"classes/pty.html#stdouthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":350,"kind":2048,"name":"write","url":"classes/pty.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":351,"kind":2048,"name":"setSize","url":"classes/pty.html#setsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":352,"kind":2048,"name":"slave","url":"classes/pty.html#slave","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pty"},{"id":353,"kind":128,"name":"Session","url":"classes/session.html","classes":"tsd-kind-class"},{"id":354,"kind":2048,"name":"create","url":"classes/session.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Session"},{"id":355,"kind":2048,"name":"put","url":"classes/session.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":356,"kind":2048,"name":"get","url":"classes/session.html#get","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Session"},{"id":357,"kind":2048,"name":"remove","url":"classes/session.html#remove","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"Session"},{"id":358,"kind":128,"name":"Shell","url":"classes/shell.html","classes":"tsd-kind-class"},{"id":359,"kind":2048,"name":"createJob","url":"classes/shell.html#createjob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":360,"kind":2048,"name":"jobController","url":"classes/shell.html#jobcontroller","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":361,"kind":2048,"name":"session","url":"classes/shell.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":362,"kind":2048,"name":"setPrompt","url":"classes/shell.html#setprompt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":363,"kind":2048,"name":"close","url":"classes/shell.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Shell"},{"id":364,"kind":128,"name":"ShellServer","url":"classes/shellserver.html","classes":"tsd-kind-class"},{"id":365,"kind":2048,"name":"create","url":"classes/shellserver.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShellServer"},{"id":366,"kind":2048,"name":"registerCommandResolver","url":"classes/shellserver.html#registercommandresolver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":367,"kind":2048,"name":"registerTermServer","url":"classes/shellserver.html#registertermserver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":368,"kind":2048,"name":"createShell","url":"classes/shellserver.html#createshell","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":369,"kind":2048,"name":"listen","url":"classes/shellserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":370,"kind":2048,"name":"close","url":"classes/shellserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":371,"kind":2048,"name":"shellHandler","url":"classes/shellserver.html#shellhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellServer"},{"id":372,"kind":128,"name":"ShellService","url":"classes/shellservice.html","classes":"tsd-kind-class"},{"id":373,"kind":2048,"name":"create","url":"classes/shellservice.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ShellService"},{"id":374,"kind":2048,"name":"start","url":"classes/shellservice.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellService"},{"id":375,"kind":2048,"name":"server","url":"classes/shellservice.html#server","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellService"},{"id":376,"kind":2048,"name":"stop","url":"classes/shellservice.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ShellService"},{"id":377,"kind":128,"name":"SignalHandler","url":"classes/signalhandler.html","classes":"tsd-kind-class"},{"id":378,"kind":2048,"name":"deliver","url":"classes/signalhandler.html#deliver","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SignalHandler"},{"id":379,"kind":128,"name":"SockJSTermHandler","url":"classes/sockjstermhandler.html","classes":"tsd-kind-class"},{"id":380,"kind":2048,"name":"handle","url":"classes/sockjstermhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SockJSTermHandler"},{"id":381,"kind":2048,"name":"create","url":"classes/sockjstermhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"SockJSTermHandler"},{"id":382,"kind":2048,"name":"termHandler","url":"classes/sockjstermhandler.html#termhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SockJSTermHandler"},{"id":383,"kind":128,"name":"Term","url":"classes/term.html","classes":"tsd-kind-class"},{"id":384,"kind":2048,"name":"resizehandler","url":"classes/term.html#resizehandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Term"},{"id":385,"kind":2048,"name":"stdinHandler","url":"classes/term.html#stdinhandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Term"},{"id":386,"kind":2048,"name":"write","url":"classes/term.html#write","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Term"},{"id":387,"kind":2048,"name":"lastAccessedTime","url":"classes/term.html#lastaccessedtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":388,"kind":2048,"name":"echo","url":"classes/term.html#echo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":389,"kind":2048,"name":"setSession","url":"classes/term.html#setsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":390,"kind":2048,"name":"interruptHandler","url":"classes/term.html#interrupthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":391,"kind":2048,"name":"suspendHandler","url":"classes/term.html#suspendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":392,"kind":2048,"name":"readline","url":"classes/term.html#readline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":393,"kind":2048,"name":"closeHandler","url":"classes/term.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":394,"kind":2048,"name":"close","url":"classes/term.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Term"},{"id":395,"kind":2048,"name":"type","url":"classes/term.html#type","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Term"},{"id":396,"kind":2048,"name":"width","url":"classes/term.html#width","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Term"},{"id":397,"kind":2048,"name":"height","url":"classes/term.html#height","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Term"},{"id":398,"kind":128,"name":"TermServer","url":"classes/termserver.html","classes":"tsd-kind-class"},{"id":399,"kind":2048,"name":"createSSHTermServer","url":"classes/termserver.html#createsshtermserver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TermServer"},{"id":400,"kind":2048,"name":"createTelnetTermServer","url":"classes/termserver.html#createtelnettermserver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TermServer"},{"id":401,"kind":2048,"name":"createHttpTermServer","url":"classes/termserver.html#createhttptermserver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TermServer"},{"id":402,"kind":2048,"name":"termHandler","url":"classes/termserver.html#termhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":403,"kind":2048,"name":"authProvider","url":"classes/termserver.html#authprovider","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":404,"kind":2048,"name":"listen","url":"classes/termserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":405,"kind":2048,"name":"actualPort","url":"classes/termserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":406,"kind":2048,"name":"close","url":"classes/termserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TermServer"},{"id":407,"kind":128,"name":"Tty","url":"classes/tty.html","classes":"tsd-kind-class"},{"id":408,"kind":2048,"name":"type","url":"classes/tty.html#type","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":409,"kind":2048,"name":"width","url":"classes/tty.html#width","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":410,"kind":2048,"name":"height","url":"classes/tty.html#height","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":411,"kind":2048,"name":"stdinHandler","url":"classes/tty.html#stdinhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":412,"kind":2048,"name":"write","url":"classes/tty.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"},{"id":413,"kind":2048,"name":"resizehandler","url":"classes/tty.html#resizehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Tty"}]}; \ No newline at end of file diff --git a/docs/@vertx/shell/classes/clitoken.html b/docs/@vertx/shell/classes/clitoken.html index 59c9afaaa..a0fb5eda3 100644 --- a/docs/@vertx/shell/classes/clitoken.html +++ b/docs/@vertx/shell/classes/clitoken.html @@ -103,7 +103,7 @@

                  isBlank

                • @@ -123,7 +123,7 @@

                  isText

                • @@ -143,7 +143,7 @@

                  raw

                • @@ -163,7 +163,7 @@

                  value

                • @@ -183,12 +183,12 @@

                  Static createBlank

                • -

                  Create a new blank token.

                  +

                  Create a new blank token.

                  Parameters

                  @@ -215,12 +215,12 @@

                  Static createText

                • -

                  Create a text token.

                  +

                  Create a text token.

                  Parameters

                  @@ -247,12 +247,12 @@

                  Static tokenize

                • -

                  Tokenize the string argument and return a list of tokens.

                  +

                  Tokenize the string argument and return a list of tokens.

                  Parameters

                  diff --git a/docs/@vertx/shell/classes/command.html b/docs/@vertx/shell/classes/command.html index 08034fad9..f6f502207 100644 --- a/docs/@vertx/shell/classes/command.html +++ b/docs/@vertx/shell/classes/command.html @@ -100,7 +100,7 @@

                  cli

                • @@ -120,12 +120,12 @@

                  complete

                • -

                  Perform command completion, when the command is done completing it should call {@link Completion#complete(List)} +

                  Perform command completion, when the command is done completing it should call {@link Completion#complete(List)} or {@link Completion#complete(String, boolean)} )} method to signal completion is done.

                  @@ -153,12 +153,12 @@

                  createProcess

                • -

                  Create a new process with empty arguments.

                  +

                  Create a new process with empty arguments.

                  Returns Process

                  @@ -167,12 +167,12 @@

                  Returns
                  -

                  Create a new process with the passed arguments.

                  +

                  Create a new process with the passed arguments.

                  Parameters

                  @@ -199,7 +199,7 @@

                  name

                • diff --git a/docs/@vertx/shell/classes/commandbuilder.html b/docs/@vertx/shell/classes/commandbuilder.html index 7c6164fab..71fb601c8 100644 --- a/docs/@vertx/shell/classes/commandbuilder.html +++ b/docs/@vertx/shell/classes/commandbuilder.html @@ -100,12 +100,12 @@

                  build

                • -

                  Build the command

                  +

                  Build the command

                  Parameters

                  @@ -132,12 +132,12 @@

                  completionHandler

                • -

                  Set the command completion handler, the completion handler when the user asks for contextual command line +

                  Set the command completion handler, the completion handler when the user asks for contextual command line completion, usually hitting the tab key.

                  @@ -151,17 +151,20 @@
                  handler: function

                  • @@ -86,15 +91,18 @@

                  Methods

                • end
                • endHandler
                • foregroundHandler
                  • +
                • height
                • interruptHandler
                • isForeground
                  • -
                • resizehandler
                  • +
                • resizehandler
                • resumeHandler
                • session
                  • -
                • stdinHandler
                  • +
                • stdinHandler
                • suspendHandler
                  • +
                • type
                • vertx
                  • -
                • write
                  • +
                • width
                  • +
                • write

    • @@ -112,7 +120,7 @@

    args

  • @@ -132,7 +140,7 @@

    argsTokens

  • @@ -152,12 +160,12 @@

    backgroundHandler

  • -

    Set a background handler, this handler is called when the command is running and put to background.

    +

    Set a background handler, this handler is called when the command is running and put to background.

    Parameters

    @@ -170,17 +178,20 @@
    handler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -202,7 +213,7 @@

      commandLine

    • @@ -223,12 +234,12 @@

      end

    • -

      End the process with the exit status {@literal 0}

      +

      End the process with the exit status {@literal 0}

      Returns void

      @@ -236,12 +247,12 @@

      Returns void
      -

      End the process.

      +

      End the process.

      Parameters

      @@ -267,12 +278,12 @@

      endHandler

    • -

      Set an end handler, this handler is called when the command is ended, for instance the command is running +

      Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes.

      @@ -286,17 +297,20 @@
      handler: function
        • -
        • (result: void): void
          • +
        • (res: void): void | Handler<void>

        • Parameters

          • -
            result: void
            +
            res: void
          -

          Returns void

          +

          Returns void + | + Handler<void> +

        • @@ -318,12 +332,12 @@

        foregroundHandler

      • -

        Set a foreground handler, this handler is called when the command is running and put to foreground.

        +

        Set a foreground handler, this handler is called when the command is running and put to foreground.

        Parameters

        @@ -336,17 +350,20 @@
        handler: function
          • -
          • (result: void): void
            • +
          • (res: void): void | Handler<void>

          • Parameters

            • -
              result: void
              +
              res: void
            -

            Returns void

            +

            Returns void + | + Handler<void> +

          • @@ -358,6 +375,27 @@

          Returns + +

          height

          +
            +
          • height(): number
            • +
          +
            +
          • + +
            +
            +

            Returns number

            +

            the current height, i.e the number of columns or {@literal -1} if unknown

            +
            • +
          +

    • interruptHandler

    @@ -368,12 +406,12 @@

    interruptHandler

  • -

    Set an interrupt handler, this handler is called when the command is interrupted, for instance user +

    Set an interrupt handler, this handler is called when the command is interrupted, for instance user press Ctrl-C.

    @@ -387,17 +425,20 @@
    handler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -419,7 +460,7 @@

      isForeground

    • @@ -429,17 +470,18 @@

      Returns boolean

    • -
    +

    resizehandler

    -
      +

      • Parameters

        @@ -449,17 +491,20 @@
        handler: function
          • -
          • (result: void): void
            • +
          • (res: void): void | Handler<void>

          • Parameters

            • -
              result: void
              +
              res: void
            -

            Returns void

            +

            Returns void + | + Handler<void> +

          • @@ -480,12 +525,12 @@

          resumeHandler

        • -

          Set a resume handler, this handler is called when the command is resumed, for instance user +

          Set a resume handler, this handler is called when the command is resumed, for instance user types bg or fg to resume the command.

          @@ -499,17 +544,20 @@
          handler: function
            • -
            • (result: void): void
              • +
            • (res: void): void | Handler<void>

            • Parameters

              • -
                result: void
                +
                res: void
              -

              Returns void

              +

              Returns void + | + Handler<void> +

            • @@ -531,7 +579,7 @@

            session

          • @@ -541,17 +589,18 @@

            Returns +

            stdinHandler

            -
              +

              • Parameters

                @@ -561,17 +610,20 @@
                handler: function
                  • -
                  • (result: string): void
                    • +
                  • (res: string): void | Handler<string>

                  • Parameters

                    • -
                      result: string
                      +
                      res: string
                    -

                    Returns void

                    +

                    Returns void + | + Handler<string> +

                  • @@ -592,12 +644,12 @@

                  suspendHandler

                • -

                  Set a suspend handler, this handler is called when the command is suspended, for instance user +

                  Set a suspend handler, this handler is called when the command is suspended, for instance user press Ctrl-Z.

                  @@ -611,17 +663,20 @@
                  handler: function
                    • -
                    • (result: void): void
                      • +
                    • (res: void): void | Handler<void>

                    • Parameters

                      • -
                        result: void
                        +
                        res: void
                      -

                      Returns void

                      +

                      Returns void + | + Handler<void> +

                    • @@ -633,6 +688,28 @@

                    Returns + +

                    type

                    +
                      +
                    • type(): string
                      • +
                    +
                      +
                    • + +
                      +
                      +

                      Returns string

                      +

                      the declared tty type, for instance {@literal vt100}, {@literal xterm-256}, etc... it can be null + when the tty does not have declared its type.

                      +
                      • +
                    +

            vertx

            @@ -643,7 +720,7 @@

            vertx

          • @@ -653,22 +730,44 @@

            Returns Vertx

    -
    +
    + +

    width

    +
      +
    • width(): number
      • +
    +
      +
    • + +
      +
      +

      Returns number

      +

      the current width, i.e the number of rows or {@literal -1} if unknown

      +
      • +
    +
    +

    write

    -
      + diff --git a/docs/@vertx/shell/classes/commandregistry.html b/docs/@vertx/shell/classes/commandregistry.html index 08619d6b3..115443ee9 100644 --- a/docs/@vertx/shell/classes/commandregistry.html +++ b/docs/@vertx/shell/classes/commandregistry.html @@ -68,7 +68,12 @@

      Class CommandRegistry

      Hierarchy

    @@ -79,9 +84,12 @@

    Index

    Methods

    @@ -91,6 +99,60 @@

    Methods

    Methods

    +
    + +

    commands

    + + +
    +
    + +

    getCommand

    +
      +
    • getCommand(name: string): Command
      • +
    +
      +
    • + +
      +
      +

      Returns a single command by its name.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        the command name

        +
        +
        • +
      +

      Returns Command

      +

      the commad or null

      +
      • +
    +

    registerCommand

    @@ -102,12 +164,12 @@

    registerCommand

  • -

    Like {@link #registerCommand(Command, Handler)}, without a completion handler.

    +

    Like {@link #registerCommand(Command, Handler)}, without a completion handler.

    Parameters

    @@ -121,12 +183,12 @@

    Returns
    -

    Register a command

    +

    Register a command

    Parameters

    @@ -145,17 +207,20 @@
    completionHandler: function

    • Static create

    @@ -329,12 +427,12 @@

    Static create

  • -

    Create a new registry.

    +

    Create a new registry.

    Parameters

    @@ -361,12 +459,12 @@

    Static getShared

  • -

    Get the shared registry for the Vert.x instance.

    +

    Get the shared registry for the Vert.x instance.

    Parameters

    @@ -415,6 +513,12 @@

    Returns CommandRegistry
      +
    • + commands +
      • +
    • + getCommand +
    • registerCommand
      • @@ -424,6 +528,9 @@

      Returns unregisterCommand +
    • + baseCommands +
    • create
      • diff --git a/docs/@vertx/shell/classes/commandresolver.html b/docs/@vertx/shell/classes/commandresolver.html index daa514cce..68b6e2082 100644 --- a/docs/@vertx/shell/classes/commandresolver.html +++ b/docs/@vertx/shell/classes/commandresolver.html @@ -69,6 +69,11 @@

      Hierarchy

    • @@ -99,7 +104,7 @@

    commands

  • @@ -119,12 +124,12 @@

    getCommand

  • -

    Returns a single command by its name.

    +

    Returns a single command by its name.

    Parameters

    @@ -151,7 +156,7 @@

    Static baseCommands

  • diff --git a/docs/@vertx/shell/classes/completion.html b/docs/@vertx/shell/classes/completion.html index e9c696ddd..ecf44ad40 100644 --- a/docs/@vertx/shell/classes/completion.html +++ b/docs/@vertx/shell/classes/completion.html @@ -102,12 +102,12 @@

    complete

  • -

    End the completion with a list of candidates, these candidates will be displayed by the shell on the console.

    +

    End the completion with a list of candidates, these candidates will be displayed by the shell on the console.

    Parameters

    @@ -124,12 +124,12 @@

    Returns void
    -

    End the completion with a value that will be inserted to complete the line.

    +

    End the completion with a value that will be inserted to complete the line.

    Parameters

    @@ -161,7 +161,7 @@

    lineTokens

  • @@ -181,7 +181,7 @@

    rawLine

  • @@ -201,7 +201,7 @@

    session

  • @@ -221,7 +221,7 @@

    vertx

  • diff --git a/docs/@vertx/shell/classes/httptermoptions.html b/docs/@vertx/shell/classes/httptermoptions.html index b728d04e8..37c1ee1dc 100644 --- a/docs/@vertx/shell/classes/httptermoptions.html +++ b/docs/@vertx/shell/classes/httptermoptions.html @@ -77,721 +77,2809 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +

    • -

    Properties

    -
    - -

    acceptBacklog

    -
    acceptBacklog: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    acceptUnmaskedFrames

    -
    acceptUnmaskedFrames: boolean
    - +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    alpnVersions

    -
    alpnVersions: HttpVersion
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    charset

    -
    charset: string
    - -
    -
    -

    Set the charset used for encoding / decoding text data from/to SockJS

    -
    -
    -
    param
    -

    the charset to use

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    clientAuth

    -
    clientAuth: ClientAuth
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    clientAuthRequired

    -
    clientAuthRequired: boolean
    - +
    + +

    getAcceptBacklog

    +
      +
    • getAcceptBacklog(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    compressionLevel

    -
    compressionLevel: number
    - +
    + +

    getAlpnVersions

    +
      +
    • getAlpnVersions(): HttpVersion
      • +
    +
      +
    • + +

      Returns HttpVersion

      +
      • +
    -
    - -

    compressionSupported

    -
    compressionSupported: boolean
    - +
    + +

    getAuthOptions

    +
      +
    • getAuthOptions(): AuthOptions
      • +
    +
      +
    • + +
      +
      +

      Returns AuthOptions

      +

      the auth options

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    getCharset

    +
      +
    • getCharset(): string
      • +
    +
      +
    • + +
      +
      +

      Set the charset used for encoding / decoding text data from/to SockJS

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    getClientAuth

    +
      +
    • getClientAuth(): ClientAuth
      • +
    +
      +
    • + +

      Returns ClientAuth

      +
      • +
    -
    - -

    decoderInitialBufferSize

    -
    decoderInitialBufferSize: number
    - +
    + +

    getCompressionLevel

    +
      +
    • getCompressionLevel(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    decompressionSupported

    -
    decompressionSupported: boolean
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getDecoderInitialBufferSize

    +
      +
    • getDecoderInitialBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    handle100ContinueAutomatically

    -
    handle100ContinueAutomatically: boolean
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    host

    -
    host: string
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2ConnectionWindowSize

    -
    http2ConnectionWindowSize: number
    - +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getHttp2ConnectionWindowSize

    +
      +
    • getHttp2ConnectionWindowSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    initialSettings

    -
    initialSettings: Http2Settings
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    intputrc

    -
    intputrc: string
    - -
    -
    -

    The path of the inputrc config.

    -
    -
    -
    param
    -

    the path of the inputrc config

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getInitialSettings

    +
      +
    • getInitialSettings(): Http2Settings
      • +
    +
      +
    • + +

      Returns Http2Settings

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getIntputrc

    +
      +
    • getIntputrc(): string
      • +
    +
      +
    • + +
      +
      +

      The path of the inputrc config.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    maxChunkSize

    -
    maxChunkSize: number
    - +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    maxHeaderSize

    -
    maxHeaderSize: number
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    maxInitialLineLength

    -
    maxInitialLineLength: number
    - +
    + +

    getMaxChunkSize

    +
      +
    • getMaxChunkSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWebsocketFrameSize

    -
    maxWebsocketFrameSize: number
    - +
    + +

    getMaxHeaderSize

    +
      +
    • getMaxHeaderSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWebsocketMessageSize

    -
    maxWebsocketMessageSize: number
    - +
    + +

    getMaxInitialLineLength

    +
      +
    • getMaxInitialLineLength(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getMaxWebsocketFrameSize

    +
      +
    • getMaxWebsocketFrameSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getMaxWebsocketMessageSize

    +
      +
    • getMaxWebsocketMessageSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getShellHtmlResource

    +
      +
    • getShellHtmlResource(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Set {@code shell.html} resource to use.

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSockJSHandlerOptions

    +
      +
    • getSockJSHandlerOptions(): SockJSHandlerOptions
      • +
    +
      +
    • + +
      +
      +

      The SockJS handler options.

      +
      +
      +

      Returns SockJSHandlerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getSockJSPath

    +
      +
    • getSockJSPath(): string
      • +
    +
      +
    • + +
      +
      +

      Configure the SockJS path, the default value is {@code /term/*}.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTermJsResource

    +
      +
    • getTermJsResource(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Set {@code term.js} resource to use.

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getVertsShellJsResource

    +
      +
    • getVertsShellJsResource(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Set {@code vertxshell.js} resource to use.

      +
      +
      +

      Returns Buffer

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWebsocketAllowServerNoContext

    +
      +
    • getWebsocketAllowServerNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getWebsocketPreferredClientNoContext

    +
      +
    • getWebsocketPreferredClientNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getWebsocketSubProtocols

    +
      +
    • getWebsocketSubProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    isAcceptUnmaskedFrames

    +
      +
    • isAcceptUnmaskedFrames(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isClientAuthRequired

    +
      +
    • isClientAuthRequired(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isCompressionSupported

    +
      +
    • isCompressionSupported(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isDecompressionSupported

    +
      +
    • isDecompressionSupported(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isHandle100ContinueAutomatically

    +
      +
    • isHandle100ContinueAutomatically(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSni

    +
      +
    • isSni(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    perFrameWebsocketCompressionSupported

    +
      +
    • perFrameWebsocketCompressionSupported(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    perMessageWebsocketCompressionSupported

    +
      +
    • perMessageWebsocketCompressionSupported(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAcceptBacklog

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        acceptBacklog: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setAcceptUnmaskedFrames

    +
      +
    • setAcceptUnmaskedFrames(acceptUnmaskedFrames: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        acceptUnmaskedFrames: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setAlpnVersions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        alpnVersions: HttpVersion
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setCharset

    + +
      +
    • + +
      +
      +

      Set the charset used for encoding / decoding text data from/to SockJS

      +
      +
      +

      Parameters

      +
        +
      • +
        charset: string
        +
        +

        the charset to use

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClientAuth

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuth: ClientAuth
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setClientAuthRequired

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuthRequired: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setCompressionLevel

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        compressionLevel: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setCompressionSupported

    +
      +
    • setCompressionSupported(compressionSupported: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        compressionSupported: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setDecoderInitialBufferSize

    +
      +
    • setDecoderInitialBufferSize(decoderInitialBufferSize: number): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        decoderInitialBufferSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setDecompressionSupported

    +
      +
    • setDecompressionSupported(decompressionSupported: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        decompressionSupported: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setHandle100ContinueAutomatically

    +
      +
    • setHandle100ContinueAutomatically(handle100ContinueAutomatically: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        handle100ContinueAutomatically: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setHttp2ConnectionWindowSize

    +
      +
    • setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        http2ConnectionWindowSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setInitialSettings

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        initialSettings: Http2Settings
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setIntputrc

    + +
      +
    • + +
      +
      +

      The path of the inputrc config.

      +
      +
      +

      Parameters

      +
        +
      • +
        intputrc: string
        +
        +

        the path of the inputrc config

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setMaxChunkSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxChunkSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setMaxHeaderSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxHeaderSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setMaxInitialLineLength

    +
      +
    • setMaxInitialLineLength(maxInitialLineLength: number): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        maxInitialLineLength: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setMaxWebsocketFrameSize

    +
      +
    • setMaxWebsocketFrameSize(maxWebsocketFrameSize: number): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWebsocketFrameSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setMaxWebsocketMessageSize

    +
      +
    • setMaxWebsocketMessageSize(maxWebsocketMessageSize: number): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWebsocketMessageSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    +
      +
    • setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    +
      +
    • setPemTrustOptions(pemTrustOptions: PemTrustOptions): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setPerFrameWebsocketCompressionSupported

    +
      +
    • setPerFrameWebsocketCompressionSupported(perFrameWebsocketCompressionSupported: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        perFrameWebsocketCompressionSupported: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setPerMessageWebsocketCompressionSupported

    +
      +
    • setPerMessageWebsocketCompressionSupported(perMessageWebsocketCompressionSupported: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        perMessageWebsocketCompressionSupported: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    setPort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        port: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    port

    -
    port: number
    - +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setShellHtmlResource

    + +
      +
    • + +
      +
      +

      Set {@code shell.html} resource to use.

      +
      +
      +

      Parameters

      +
        +
      • +
        shellHtmlResource: Buffer
        +
        +

        the resource

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setSni

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sni: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setSockJSHandlerOptions

    +
      +
    • setSockJSHandlerOptions(sockJSHandlerOptions: SockJSHandlerOptions): HttpTermOptions
      • +
    +
      +
    • + +
      +
      +

      The SockJS handler options.

      +
      +
      +

      Parameters

      +
        +
      • +
        sockJSHandlerOptions: SockJSHandlerOptions
        +
        +

        the options to use

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    shellHtmlResource

    -
    shellHtmlResource: Buffer
    - -
    -
    -

    Set {@code shell.html} resource to use.

    -
    -
    -
    param
    -

    the resource

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setSockJSPath

    + +
      +
    • + +
      +
      +

      Configure the SockJS path, the default value is {@code /term/*}.

      +
      +
      +

      Parameters

      +
        +
      • +
        sockJSPath: string
        +
        +

        the new SockJS path

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sni

    -
    sni: boolean
    - +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    sockJSHandlerOptions

    -
    sockJSHandlerOptions: SockJSHandlerOptions
    - -
    -
    -

    The SockJS handler options.

    -
    -
    -
    param
    -

    the options to use

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    sockJSPath

    -
    sockJSPath: string
    - -
    -
    -

    Configure the SockJS path, the default value is {@code /term/*}.

    -
    -
    -
    param
    -

    the new SockJS path

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTermJsResource

    + +
      +
    • + +
      +
      +

      Set {@code term.js} resource to use.

      +
      +
      +

      Parameters

      +
        +
      • +
        termJsResource: Buffer
        +
        +

        the resource

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    termJsResource

    -
    termJsResource: Buffer
    - -
    -
    -

    Set {@code term.js} resource to use.

    -
    -
    -
    param
    -

    the resource

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setVertsShellJsResource

    +
      +
    • setVertsShellJsResource(vertsShellJsResource: Buffer): HttpTermOptions
      • +
    +
      +
    • + +
      +
      +

      Set {@code vertxshell.js} resource to use.

      +
      +
      +

      Parameters

      +
        +
      • +
        vertsShellJsResource: Buffer
        +
        +

        the resource

        +
        +
        • +
      +

      Returns HttpTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setWebsocketAllowServerNoContext

    +
      +
    • setWebsocketAllowServerNoContext(websocketAllowServerNoContext: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketAllowServerNoContext: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setWebsocketCompressionLevel

    +
      +
    • setWebsocketCompressionLevel(websocketCompressionLevel: number): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionLevel: number
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setWebsocketPreferredClientNoContext

    +
      +
    • setWebsocketPreferredClientNoContext(websocketPreferredClientNoContext: boolean): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketPreferredClientNoContext: boolean
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    vertsShellJsResource

    -
    vertsShellJsResource: Buffer
    - -
    -
    -

    Set {@code vertxshell.js} resource to use.

    -
    -
    -
    param
    -

    the resource

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketSubProtocols

    +
      +
    • setWebsocketSubProtocols(websocketSubProtocols: string): HttpTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketSubProtocols: string
        +
        • +
      +

      Returns HttpTermOptions

      +
      • +
    -
    - -

    websocketSubProtocols

    -
    websocketSubProtocols: string
    - +
    + +

    websocketCompressionLevel

    +
      +
    • websocketCompressionLevel(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    @@ -834,173 +2922,386 @@

    websocketSubProtocols

  • HttpTermOptions
    • diff --git a/docs/@vertx/shell/classes/job.html b/docs/@vertx/shell/classes/job.html index 11c826005..b91692468 100644 --- a/docs/@vertx/shell/classes/job.html +++ b/docs/@vertx/shell/classes/job.html @@ -111,7 +111,7 @@

    id

  • @@ -131,12 +131,12 @@

    interrupt

  • -

    Attempt to interrupt the job.

    +

    Attempt to interrupt the job.

    Returns boolean

    @@ -154,7 +154,7 @@

    lastStopped

  • @@ -174,7 +174,7 @@

    line

  • @@ -194,7 +194,7 @@

    process

  • @@ -215,12 +215,12 @@

    resume

  • -

    Resume the job to foreground.

    +

    Resume the job to foreground.

    Returns Job

    @@ -228,12 +228,12 @@

    Returns
    -

    Resume the job.

    +

    Resume the job.

    Parameters

    @@ -259,12 +259,12 @@

    run

  • -

    Run the job, before running the job a Tty must be set.

    +

    Run the job, before running the job a Tty must be set.

    Returns Job

    @@ -282,12 +282,12 @@

    setSession

  • -

    Set a session on the job.

    +

    Set a session on the job.

    Parameters

    @@ -314,12 +314,12 @@

    setTty

  • -

    Set a tty on the job.

    +

    Set a tty on the job.

    Parameters

    @@ -346,7 +346,7 @@

    status

  • @@ -366,12 +366,12 @@

    statusUpdateHandler

  • -

    Set an handler called when the job terminates.

    +

    Set an handler called when the job terminates.

    Parameters

    @@ -384,17 +384,20 @@
    handler: function
      • @@ -416,12 +419,12 @@

      suspend

    • -

      Resume the job.

      +

      Resume the job.

      Returns Job

      @@ -439,12 +442,12 @@

      terminate

    • -

      Terminate the job.

      +

      Terminate the job.

      Returns void

      @@ -461,12 +464,12 @@

      toBackground

    • -

      Send the job to background.

      +

      Send the job to background.

      Returns Job

      @@ -484,12 +487,12 @@

      toForeground

    • -

      Send the job to foreground.

      +

      Send the job to foreground.

      Returns Job

      diff --git a/docs/@vertx/shell/classes/jobcontroller.html b/docs/@vertx/shell/classes/jobcontroller.html index e45429122..d5cb23366 100644 --- a/docs/@vertx/shell/classes/jobcontroller.html +++ b/docs/@vertx/shell/classes/jobcontroller.html @@ -102,12 +102,12 @@

      close

    • -

      Close the controller and terminate all the underlying jobs, a closed controller does not accept anymore jobs.

      +

      Close the controller and terminate all the underlying jobs, a closed controller does not accept anymore jobs.

      Parameters

      @@ -117,17 +117,20 @@
      completionHandler: function
        • -
        • (result: void): void
          • +
        • (res: void): void | Handler<void>

        • Parameters

          • -
            result: void
            +
            res: void
          -

          Returns void

          +

          Returns void + | + Handler<void> +

        • @@ -139,12 +142,12 @@

        Returns void
        -

        Close the shell session and terminate all the underlying jobs.

        +

        Close the shell session and terminate all the underlying jobs.

        Returns void

        @@ -161,12 +164,12 @@

        createJob

      • -

        Create a job wrapping a process.

        +

        Create a job wrapping a process.

        Parameters

        @@ -199,7 +202,7 @@

        foregroundJob

      • @@ -219,12 +222,12 @@

        getJob

      • -

        Returns an active job in this session by its {@literal id}.

        +

        Returns an active job in this session by its {@literal id}.

        Parameters

        @@ -251,7 +254,7 @@

        jobs

      • diff --git a/docs/@vertx/shell/classes/process.html b/docs/@vertx/shell/classes/process.html index 819b87846..5edbb9351 100644 --- a/docs/@vertx/shell/classes/process.html +++ b/docs/@vertx/shell/classes/process.html @@ -110,7 +110,7 @@

        exitCode

      • @@ -130,7 +130,7 @@

        getSession

      • @@ -150,7 +150,7 @@

        getTty

      • @@ -171,12 +171,12 @@

        interrupt

      • -

        Attempt to interrupt the process.

        +

        Attempt to interrupt the process.

        Returns boolean

        @@ -185,12 +185,12 @@

        Returns boolean
        -

        Attempt to interrupt the process.

        +

        Attempt to interrupt the process.

        Parameters

        @@ -203,17 +203,20 @@
        completionHandler: function
          • -
          • (result: void): void
            • +
          • (res: void): void | Handler<void>

          • Parameters

            • -
              result: void
              +
              res: void
            -

            Returns void

            +

            Returns void + | + Handler<void> +

          • @@ -238,12 +241,12 @@

          resume

        • -

          Suspend the process.

          +

          Suspend the process.

          Returns void

          @@ -251,12 +254,12 @@

          Returns void
          -

          Suspend the process.

          +

          Suspend the process.

          Parameters

          @@ -270,12 +273,12 @@

          Returns void
          -

          Suspend the process.

          +

          Suspend the process.

          Parameters

          @@ -288,17 +291,20 @@
          completionHandler: function
            • -
            • (result: void): void
              • +
            • (res: void): void | Handler<void>

            • Parameters

              • -
                result: void
                +
                res: void
              -

              Returns void

              +

              Returns void + | + Handler<void> +

            • @@ -310,12 +316,12 @@

            Returns void
            -

            Suspend the process.

            +

            Suspend the process.

            Parameters

            @@ -331,17 +337,20 @@
            completionHandler: function
              • -
              • (result: void): void
                • +
              • (res: void): void | Handler<void>

              • Parameters

                • -
                  result: void
                  +
                  res: void
                -

                Returns void

                +

                Returns void + | + Handler<void> +

              • @@ -363,12 +372,12 @@

              run

            • -

              Run the process.

              +

              Run the process.

              Returns void

              @@ -376,12 +385,12 @@

              Returns void
              -

              Run the process.

              +

              Run the process.

              Parameters

              @@ -404,12 +413,12 @@

              setSession

            • -

              Set the process session

              +

              Set the process session

              Parameters

              @@ -436,12 +445,12 @@

              setTty

            • -

              Set the process tty.

              +

              Set the process tty.

              Parameters

              @@ -468,7 +477,7 @@

              status

            • @@ -489,12 +498,12 @@

              suspend

            • -

              Resume the process.

              +

              Resume the process.

              Returns void

              @@ -502,12 +511,12 @@

              Returns void
              -

              Resume the process.

              +

              Resume the process.

              Parameters

              @@ -520,17 +529,20 @@
              completionHandler: function
                • -
                • (result: void): void
                  • +
                • (res: void): void | Handler<void>

                • Parameters

                  • -
                    result: void
                    +
                    res: void
                  -

                  Returns void

                  +

                  Returns void + | + Handler<void> +

                • @@ -552,12 +564,12 @@

                terminate

              • -

                Terminate the process.

                +

                Terminate the process.

                Returns void

                @@ -565,12 +577,12 @@

                Returns void
                -

                Terminate the process.

                +

                Terminate the process.

                Parameters

                @@ -583,17 +595,20 @@
                completionHandler: function
                  • -
                  • (result: void): void
                    • +
                  • (res: void): void | Handler<void>

                  • Parameters

                    • -
                      result: void
                      +
                      res: void
                    -

                    Returns void

                    +

                    Returns void + | + Handler<void> +

                  • @@ -614,12 +629,12 @@

                  terminatedHandler

                • -

                  Set an handler for being notified when the process terminates.

                  +

                  Set an handler for being notified when the process terminates.

                  Parameters

                  @@ -632,17 +647,20 @@
                  handler: function
                    • -
                    • (result: number): void
                      • +
                    • (res: number): void | Handler<number>

                    • Parameters

                      • -
                        result: number
                        +
                        res: number
                      -

                      Returns void

                      +

                      Returns void + | + Handler<number> +

                    • @@ -665,12 +683,12 @@

                    toBackground

                  • -

                    Set the process in background.

                    +

                    Set the process in background.

                    Returns void

                    @@ -678,12 +696,12 @@

                    Returns void
                    -

                    Set the process in background.

                    +

                    Set the process in background.

                    Parameters

                    @@ -696,17 +714,20 @@
                    completionHandler: function
                      • -
                      • (result: void): void
                        • +
                      • (res: void): void | Handler<void>

                      • Parameters

                        • -
                          result: void
                          +
                          res: void
                        -

                        Returns void

                        +

                        Returns void + | + Handler<void> +

                      • @@ -728,12 +749,12 @@

                      toForeground

                    • -

                      Set the process in foreground.

                      +

                      Set the process in foreground.

                      Returns void

                      @@ -741,12 +762,12 @@

                      Returns void
                      -

                      Set the process in foreground.

                      +

                      Set the process in foreground.

                      Parameters

                      @@ -759,17 +780,20 @@
                      completionHandler: function

    • Methods

    -
    +

    get

    -
      -
    • get(key: string): Object
      • +
        +
      • get<T>(key: string): T
      • -

        Get some data from the session

        +

        Get some data from the session

        +

        Type parameters

        +
          +
        • +

          T

          +
          • +

        Parameters

        • @@ -117,7 +123,7 @@
          key: string
        -

        Returns Object

        +

        Returns T

        the data

      @@ -132,12 +138,12 @@

      put

    • -

      Put some data in a session

      +

      Put some data in a session

      Parameters

      @@ -160,24 +166,30 @@

      Returns +

      remove

      -
        -
      • remove(key: string): Object
        • +
          +
        • remove<T>(key: string): T
        • -

          Remove some data from the session

          +

          Remove some data from the session

          +

          Type parameters

          +
            +
          • +

            T

            +
            • +

          Parameters

          • @@ -187,7 +199,7 @@
            key: string
          -

          Returns Object

          +

          Returns T

          the data that was there or null if none there

        @@ -202,12 +214,12 @@

        Static create

      • -

        Create a new empty session.

        +

        Create a new empty session.

        Returns Session

        @@ -274,13 +286,13 @@

        Returns Session
          -
        • +
        • get
        • put
          • -
        • +
        • remove
        • diff --git a/docs/@vertx/shell/classes/shell.html b/docs/@vertx/shell/classes/shell.html index 7d076a82f..c61fa476a 100644 --- a/docs/@vertx/shell/classes/shell.html +++ b/docs/@vertx/shell/classes/shell.html @@ -83,6 +83,7 @@

          Methods

        • createJob
        • jobController
        • session
          • +
        • setPrompt

      @@ -100,12 +101,12 @@

      close

    • -

      Close the shell.

      +

      Close the shell.

      Returns void

      @@ -123,12 +124,12 @@

      createJob

    • -

      Create a job, the created job should then be executed with the {@link io.vertx.ext.shell.system.Job#run} method.

      +

      Create a job, the created job should then be executed with the {@link io.vertx.ext.shell.system.Job#run} method.

      Parameters

      @@ -146,12 +147,12 @@

      Returns
      -

      See {@link #createJob(List)}

      +

      See {@link #createJob(List)}

      Parameters

      @@ -174,7 +175,7 @@

      jobController

    • @@ -194,7 +195,7 @@

      session

    • @@ -204,6 +205,55 @@

      Returns + +

      setPrompt

      +
        +
      • setPrompt(prompt: function): void
        • +
      +
        +
      • + +
        +
        +

        Set a new prompt in this session.

        +
        +
        +

        Parameters

        +
          +
        • +
          prompt: function
          +
          +

          the new prompt will be calculated when it's needed.

          +
          +
            +
          • + +
              +
            • +

              Parameters

              + +

              Returns string

              +
              • +
            +
            • +
          +
          • +
        +

        Returns void

        +
        • +
      +

    @@ -278,6 +328,9 @@

    Returns session +
  • + setPrompt +
    • diff --git a/docs/@vertx/shell/classes/shellserver.html b/docs/@vertx/shell/classes/shellserver.html index 51381dcce..714030a83 100644 --- a/docs/@vertx/shell/classes/shellserver.html +++ b/docs/@vertx/shell/classes/shellserver.html @@ -84,6 +84,7 @@

    Methods

  • listen
  • registerCommandResolver
  • registerTermServer
    • +
  • shellHandler
  • create
    • @@ -103,12 +104,12 @@

    close

  • -

    Close the shell server, this is an asynchronous close.

    +

    Close the shell server, this is an asynchronous close.

    Returns void

    @@ -116,12 +117,12 @@

    Returns void
    -

    Close the shell server, this is an asynchronous close.

    +

    Close the shell server, this is an asynchronous close.

    Parameters

    @@ -134,17 +135,20 @@
    completionHandler: function

    • Static create

    @@ -340,12 +400,12 @@

    Static create

  • -

    Create a new shell server with default options.

    +

    Create a new shell server with default options.

    Parameters

    @@ -369,12 +429,12 @@

    Returns
    -

    Create a new shell server with specific options.

    +

    Create a new shell server with specific options.

    Parameters

    @@ -471,6 +531,9 @@

    Returns registerTermServer

    • +
  • + shellHandler +
  • create
    • diff --git a/docs/@vertx/shell/classes/shellserveroptions.html b/docs/@vertx/shell/classes/shellserveroptions.html index 159761779..3e06154b0 100644 --- a/docs/@vertx/shell/classes/shellserveroptions.html +++ b/docs/@vertx/shell/classes/shellserveroptions.html @@ -77,86 +77,226 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    reaperInterval

    -
    reaperInterval: number
    - -
    -
    -

    Set the repear interval, i.e the period at which session eviction is performed.

    -
    -
    -
    param
    -

    the new repeat interval

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    sessionTimeout

    -
    sessionTimeout: number
    - -
    -
    -

    Set the session timeout.

    -
    -
    -
    param
    -

    the new session timeout

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getReaperInterval

    +
      +
    • getReaperInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Set the repear interval, i.e the period at which session eviction is performed.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    welcomeMessage

    -
    welcomeMessage: string
    - -
    -
    -

    Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

    -
    -
    -
    param
    -

    the welcome message

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getSessionTimeout

    +
      +
    • getSessionTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the session timeout.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWelcomeMessage

    +
      +
    • getWelcomeMessage(): string
      • +
    +
      +
    • + +
      +
      +

      Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setReaperInterval

    + +
      +
    • + +
      +
      +

      Set the repear interval, i.e the period at which session eviction is performed.

      +
      +
      +

      Parameters

      +
        +
      • +
        reaperInterval: number
        +
        +

        the new repeat interval

        +
        +
        • +
      +

      Returns ShellServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSessionTimeout

    + +
      +
    • + +
      +
      +

      Set the session timeout.

      +
      +
      +

      Parameters

      +
        +
      • +
        sessionTimeout: number
        +
        +

        the new session timeout

        +
        +
        • +
      +

      Returns ShellServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWelcomeMessage

    + +
      +
    • + +
      +
      +

      Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

      +
      +
      +

      Parameters

      +
        +
      • +
        welcomeMessage: string
        +
        +

        the welcome message

        +
        +
        • +
      +

      Returns ShellServerOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -226,14 +366,26 @@

    welcomeMessage

  • ShellServerOptions
    • diff --git a/docs/@vertx/shell/classes/shellservice.html b/docs/@vertx/shell/classes/shellservice.html index d4bd36a44..87b41481e 100644 --- a/docs/@vertx/shell/classes/shellservice.html +++ b/docs/@vertx/shell/classes/shellservice.html @@ -100,7 +100,7 @@

    server

  • @@ -121,12 +121,12 @@

    start

  • -

    Start the shell service, this is an asynchronous start.

    +

    Start the shell service, this is an asynchronous start.

    Returns void

    @@ -134,12 +134,12 @@

    Returns void
    -

    Start the shell service, this is an asynchronous start.

    +

    Start the shell service, this is an asynchronous start.

    Parameters

    @@ -152,17 +152,20 @@
    startHandler: function

    • -

    Properties

    -
    - -

    httpOptions

    -
    httpOptions: HttpTermOptions
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    reaperInterval

    -
    reaperInterval: number
    - -
    -
    -

    Set the repear interval, i.e the period at which session eviction is performed.

    -
    -
    -
    param
    -

    the new repeat interval

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getHttpOptions

    + +
    -
    - -

    sessionTimeout

    -
    sessionTimeout: number
    - -
    -
    -

    Set the session timeout.

    -
    -
    -
    param
    -

    the new session timeout

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getReaperInterval

    +
      +
    • getReaperInterval(): number
      • +
    +
      +
    • + +
      +
      +

      Set the repear interval, i.e the period at which session eviction is performed.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    sshOptions

    -
    sshOptions: SSHTermOptions
    - -
    -
    -

    Set the SSH options, if the option is null, SSH will not be started.

    -
    -
    -
    param
    -

    the ssh options

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getSSHOptions

    + +
      +
    • + +
      +
      +

      Set the SSH options, if the option is null, SSH will not be started.

      +
      +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    telnetOptions

    -
    telnetOptions: TelnetTermOptions
    - -
    -
    -

    Set the Telnet options, if the option is null, Telnet will not be started.

    -
    -
    -
    param
    -

    the ssh options

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getSessionTimeout

    +
      +
    • getSessionTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the session timeout.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    welcomeMessage

    -
    welcomeMessage: string
    - -
    -
    -

    Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

    -
    -
    -
    param
    -

    the welcome message

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getTelnetOptions

    + +
      +
    • + +
      +
      +

      Set the Telnet options, if the option is null, Telnet will not be started.

      +
      +
      +

      Returns TelnetTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWelcomeMessage

    +
      +
    • getWelcomeMessage(): string
      • +
    +
      +
    • + +
      +
      +

      Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHttpOptions

    + + +
    +
    + +

    setReaperInterval

    + +
      +
    • + +
      +
      +

      Set the repear interval, i.e the period at which session eviction is performed.

      +
      +
      +

      Parameters

      +
        +
      • +
        reaperInterval: number
        +
        +

        the new repeat interval

        +
        +
        • +
      +

      Returns ShellServiceOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSSHOptions

    + +
      +
    • + +
      +
      +

      Set the SSH options, if the option is null, SSH will not be started.

      +
      +
      +

      Parameters

      + +

      Returns ShellServiceOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setSessionTimeout

    + +
      +
    • + +
      +
      +

      Set the session timeout.

      +
      +
      +

      Parameters

      +
        +
      • +
        sessionTimeout: number
        +
        +

        the new session timeout

        +
        +
        • +
      +

      Returns ShellServiceOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setTelnetOptions

    + +
      +
    • + +
      +
      +

      Set the Telnet options, if the option is null, Telnet will not be started.

      +
      +
      +

      Parameters

      + +

      Returns ShellServiceOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setWelcomeMessage

    + +
      +
    • + +
      +
      +

      Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

      +
      +
      +

      Parameters

      +
        +
      • +
        welcomeMessage: string
        +
        +

        the welcome message

        +
        +
        • +
      +

      Returns ShellServiceOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -291,23 +528,44 @@

    welcomeMessage

  • ShellServiceOptions
    • diff --git a/docs/@vertx/shell/classes/signalhandler.html b/docs/@vertx/shell/classes/signalhandler.html index 01246f06d..0778e40b8 100644 --- a/docs/@vertx/shell/classes/signalhandler.html +++ b/docs/@vertx/shell/classes/signalhandler.html @@ -97,7 +97,7 @@

    deliver

  • Parameters

    diff --git a/docs/@vertx/shell/classes/sockjstermhandler.html b/docs/@vertx/shell/classes/sockjstermhandler.html index b3b732b07..6dc8e340d 100644 --- a/docs/@vertx/shell/classes/sockjstermhandler.html +++ b/docs/@vertx/shell/classes/sockjstermhandler.html @@ -72,6 +72,12 @@

    Hierarchy

    • +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -99,7 +105,7 @@

    handle

  • Parameters

    @@ -122,7 +128,7 @@

    termHandler

  • Parameters

    @@ -132,17 +138,20 @@
    handler: function
    • -

    Properties

    -
    - -

    defaultCharset

    -
    defaultCharset: string
    - -
    -
    -

    Set the default charset to use when the client does not specifies one.

    -
    -
    -
    param
    -

    the default charset

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Set the host

    -
    -
    -
    param
    -

    the host

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getAuthOptions

    +
      +
    • getAuthOptions(): AuthOptions
      • +
    +
      +
    • + +
      +
      +

      Returns AuthOptions

      +

      the auth options

      +
      • +
    -
    - -

    intputrc

    -
    intputrc: string
    - -
    -
    -

    The path of the inputrc config.

    -
    -
    -
    param
    -

    the path of the inputrc config

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDefaultCharset

    +
      +
    • getDefaultCharset(): string
      • +
    +
      +
    • + +
      +
      +

      Set the default charset to use when the client does not specifies one.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Set the host

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getIntputrc

    +
      +
    • getIntputrc(): string
      • +
    +
      +
    • + +
      +
      +

      The path of the inputrc config.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Set the port

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +

    keyPairOptions

    -
    keyPairOptions: JksOptions
    - -
    -
    -

    Set the key pair options in jks format, aka Java keystore.

    -
    -
    -
    param
    -

    the key store in jks format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • keyPairOptions(): JksOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key pair options in jks format, aka Java keystore.

      +
      +
      +

      Returns JksOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +

    pemKeyPairOptions

    -
    pemKeyPairOptions: PemKeyCertOptions
    - -
    -
    -

    Set the key pair store options in pem format.

    -
    -
    -
    param
    -

    the options in pem format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • pemKeyPairOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key pair store options in pem format.

      +
      +
      +

      Returns PemKeyCertOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    +

    pfxKeyPairOptions

    -
    pfxKeyPairOptions: PfxOptions
    - -
    -
    -

    Set the key pair options in pfx format.

    -
    -
    -
    param
    -

    the key cert options in pfx format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
      +
    • pfxKeyPairOptions(): PfxOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key pair options in pfx format.

      +
      +
      +

      Returns PfxOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Set the port

    -
    -
    -
    param
    -

    the port

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setDefaultCharset

    + +
      +
    • + +
      +
      +

      Set the default charset to use when the client does not specifies one.

      +
      +
      +

      Parameters

      +
        +
      • +
        defaultCharset: string
        +
        +

        the default charset

        +
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Set the host

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the host

        +
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIntputrc

    + +
      +
    • + +
      +
      +

      The path of the inputrc config.

      +
      +
      +

      Parameters

      +
        +
      • +
        intputrc: string
        +
        +

        the path of the inputrc config

        +
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setKeyPairOptions

    + +
      +
    • + +
      +
      +

      Set the key pair options in jks format, aka Java keystore.

      +
      +
      +

      Parameters

      +
        +
      • +
        keyPairOptions: JksOptions
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPemKeyPairOptions

    +
      +
    • setPemKeyPairOptions(pemKeyPairOptions: PemKeyCertOptions): SSHTermOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key pair store options in pem format.

      +
      +
      +

      Parameters

      +
        +
      • +
        pemKeyPairOptions: PemKeyCertOptions
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPfxKeyPairOptions

    +
      +
    • setPfxKeyPairOptions(pfxKeyPairOptions: PfxOptions): SSHTermOptions
      • +
    +
      +
    • + +
      +
      +

      Set the key pair options in pfx format.

      +
      +
      +

      Parameters

      +
        +
      • +
        pfxKeyPairOptions: PfxOptions
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Set the port

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns SSHTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -310,26 +594,53 @@

    port

  • SSHTermOptions
    • diff --git a/docs/@vertx/shell/classes/telnettermoptions.html b/docs/@vertx/shell/classes/telnettermoptions.html index aa40d34d1..09867efbb 100644 --- a/docs/@vertx/shell/classes/telnettermoptions.html +++ b/docs/@vertx/shell/classes/telnettermoptions.html @@ -77,486 +77,1781 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    acceptBacklog

    -
    acceptBacklog: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    charset

    -
    charset: string
    - -
    -
    -

    Set the charset to use when binary mode is active, see {@link #setInBinary(boolean)} and {@link #setOutBinary(boolean)}.

    -
    -
    -
    param
    -

    the charset

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    -
    - -

    clientAuth

    -
    clientAuth: ClientAuth
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    -
    - -

    clientAuthRequired

    -
    clientAuthRequired: boolean
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): TelnetTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    getAcceptBacklog

    +
      +
    • getAcceptBacklog(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getCharset

    +
      +
    • getCharset(): string
      • +
    +
      +
    • + +
      +
      +

      Set the charset to use when binary mode is active, see {@link #setInBinary(boolean)} and {@link #setOutBinary(boolean)}.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getClientAuth

    +
      +
    • getClientAuth(): ClientAuth
      • +
    +
      +
    • + +

      Returns ClientAuth

      +
      • +
    -
    - -

    host

    -
    host: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    inBinary

    -
    inBinary: boolean
    - -
    -
    -

    Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This - allows to send data in 8 bit format and thus charset like UTF-8.

    -
    -
    -
    param
    -

    the in binary value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    intputrc

    -
    intputrc: string
    - -
    -
    -

    The path of the inputrc config.

    -
    -
    -
    param
    -

    the path of the inputrc config

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getInBinary

    +
      +
    • getInBinary(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This + allows to send data in 8 bit format and thus charset like UTF-8.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    outBinary

    -
    outBinary: boolean
    - -
    -
    -

    Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This - allows to send data in 8 bit format and thus charset like UTF-8.

    -
    -
    -
    param
    -

    the out binary value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getIntputrc

    +
      +
    • getIntputrc(): string
      • +
    +
      +
    • + +
      +
      +

      The path of the inputrc config.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    -
    - -

    port

    -
    port: number
    - +
    + +

    getOutBinary

    +
      +
    • getOutBinary(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This + allows to send data in 8 bit format and thus charset like UTF-8.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    -
    - -

    sni

    -
    sni: boolean
    - +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    isClientAuthRequired

    +
      +
    • isClientAuthRequired(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    isSni

    +
      +
    • isSni(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAcceptBacklog

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        acceptBacklog: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setCharset

    + +
      +
    • + +
      +
      +

      Set the charset to use when binary mode is active, see {@link #setInBinary(boolean)} and {@link #setOutBinary(boolean)}.

      +
      +
      +

      Parameters

      +
        +
      • +
        charset: string
        +
        +

        the charset

        +
        +
        • +
      +

      Returns TelnetTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setClientAuth

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuth: ClientAuth
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setClientAuthRequired

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuthRequired: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): TelnetTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setInBinary

    + +
      +
    • + +
      +
      +

      Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This + allows to send data in 8 bit format and thus charset like UTF-8.

      +
      +
      +

      Parameters

      +
        +
      • +
        inBinary: boolean
        +
        +

        the in binary value

        +
        +
        • +
      +

      Returns TelnetTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setIntputrc

    + +
      +
    • + +
      +
      +

      The path of the inputrc config.

      +
      +
      +

      Parameters

      +
        +
      • +
        intputrc: string
        +
        +

        the path of the inputrc config

        +
        +
        • +
      +

      Returns TelnetTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): TelnetTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): TelnetTermOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setOutBinary

    + +
      +
    • + +
      +
      +

      Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This + allows to send data in 8 bit format and thus charset like UTF-8.

      +
      +
      +

      Parameters

      +
        +
      • +
        outBinary: boolean
        +
        +

        the out binary value

        +
        +
        • +
      +

      Returns TelnetTermOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        port: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setSni

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sni: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    +
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns TelnetTermOptions

      +
      • +
    @@ -641,119 +1936,245 @@

    usePooledBuffers

  • TelnetTermOptions
    • diff --git a/docs/@vertx/shell/classes/term.html b/docs/@vertx/shell/classes/term.html index df4f63a91..6b8eb28cb 100644 --- a/docs/@vertx/shell/classes/term.html +++ b/docs/@vertx/shell/classes/term.html @@ -68,7 +68,12 @@

    Class Term

    Hierarchy

    • - Term + Tty +
        +
      • + Term +
        • +
    @@ -82,14 +87,17 @@

    Methods

  • close
  • closeHandler
  • echo
    • +
  • height
  • interruptHandler
  • lastAccessedTime
  • readline
    • -
  • resizehandler
    • +
  • resizehandler
  • setSession
    • -
  • stdinHandler
    • +
  • stdinHandler
  • suspendHandler
    • -
  • write
    • +
  • type
    • +
  • width
    • +
  • write
    • @@ -107,12 +115,12 @@

    close

  • -

    Close the connection to terminal.

    +

    Close the connection to terminal.

    Returns void

    @@ -129,12 +137,12 @@

    closeHandler

  • -

    Set a handler that will be called when the terminal is closed.

    +

    Set a handler that will be called when the terminal is closed.

    Parameters

    @@ -147,17 +155,20 @@
    handler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -179,12 +190,12 @@

      echo

    • -

      Echo some text in the terminal, escaped if necessary.

      +

      Echo some text in the terminal, escaped if necessary.

      Parameters

      @@ -201,6 +212,27 @@

      Returns + +

      height

      +
        +
      • height(): number
        • +
      +
        +
      • + +
        +
        +

        Returns number

        +

        the current height, i.e the number of columns or {@literal -1} if unknown

        +
        • +
      +

    • interruptHandler

    @@ -211,12 +243,12 @@

    interruptHandler

  • -

    Set an interrupt signal handler on the term.

    +

    Set an interrupt signal handler on the term.

    Parameters

    @@ -243,7 +275,7 @@

    lastAccessedTime

  • @@ -264,12 +296,12 @@

    readline

  • -

    Prompt the user a line of text.

    +

    Prompt the user a line of text.

    Parameters

    @@ -288,17 +320,20 @@
    lineHandler: function
      • -
      • (result: string): void
        • +
      • (res: string): void | Handler<string>

      • Parameters

        • -
          result: string
          +
          res: string
        -

        Returns void

        +

        Returns void + | + Handler<string> +

      • @@ -310,12 +345,12 @@

      Returns void
      -

      Prompt the user a line of text, providing a completion handler to handle user's completion.

      +

      Prompt the user a line of text, providing a completion handler to handle user's completion.

      Parameters

      @@ -334,17 +369,20 @@
      lineHandler: function
        • -
        • (result: string): void
          • +
        • (res: string): void | Handler<string>

        • Parameters

          • -
            result: string
            +
            res: string
          -

          Returns void

          +

          Returns void + | + Handler<string> +

        • @@ -358,17 +396,20 @@
        completionHandler: function

    • -
    +

    resizehandler

    -
    @@ -108,7 +108,7 @@

    STOPPED

    STOPPED:
    @@ -118,7 +118,7 @@

    TERMINATED

    TERMINATED:
    diff --git a/docs/@vertx/sql-common/assets/js/search.js b/docs/@vertx/sql-common/assets/js/search.js deleted file mode 100644 index b914721b3..000000000 --- a/docs/@vertx/sql-common/assets/js/search.js +++ /dev/null @@ -1,3 +0,0 @@ -var typedoc = typedoc || {}; - typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","256":"Interface","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"FetchDirection","url":"enums/fetchdirection.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"FORWARD","url":"enums/fetchdirection.html#forward","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"FetchDirection"},{"id":2,"kind":16,"name":"REVERSE","url":"enums/fetchdirection.html#reverse","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"FetchDirection"},{"id":3,"kind":16,"name":"UNKNOWN","url":"enums/fetchdirection.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"FetchDirection"},{"id":4,"kind":4,"name":"ResultSetConcurrency","url":"enums/resultsetconcurrency.html","classes":"tsd-kind-enum"},{"id":5,"kind":16,"name":"READ_ONLY","url":"enums/resultsetconcurrency.html#read_only","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetConcurrency"},{"id":6,"kind":16,"name":"UPDATABLE","url":"enums/resultsetconcurrency.html#updatable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetConcurrency"},{"id":7,"kind":4,"name":"ResultSetType","url":"enums/resultsettype.html","classes":"tsd-kind-enum"},{"id":8,"kind":16,"name":"FORWARD_ONLY","url":"enums/resultsettype.html#forward_only","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetType"},{"id":9,"kind":16,"name":"SCROLL_INSENSITIVE","url":"enums/resultsettype.html#scroll_insensitive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetType"},{"id":10,"kind":16,"name":"SCROLL_SENSITIVE","url":"enums/resultsettype.html#scroll_sensitive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetType"},{"id":11,"kind":4,"name":"TransactionIsolation","url":"enums/transactionisolation.html","classes":"tsd-kind-enum"},{"id":12,"kind":16,"name":"READ_UNCOMMITTED","url":"enums/transactionisolation.html#read_uncommitted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":13,"kind":16,"name":"READ_COMMITTED","url":"enums/transactionisolation.html#read_committed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":14,"kind":16,"name":"REPEATABLE_READ","url":"enums/transactionisolation.html#repeatable_read","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":15,"kind":16,"name":"SERIALIZABLE","url":"enums/transactionisolation.html#serializable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":16,"kind":16,"name":"NONE","url":"enums/transactionisolation.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":17,"kind":128,"name":"ResultSet","url":"classes/resultset.html","classes":"tsd-kind-class"},{"id":18,"kind":1024,"name":"columnNames","url":"classes/resultset.html#columnnames","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ResultSet"},{"id":19,"kind":1024,"name":"next","url":"classes/resultset.html#next","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ResultSet"},{"id":20,"kind":1024,"name":"output","url":"classes/resultset.html#output","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ResultSet"},{"id":21,"kind":1024,"name":"results","url":"classes/resultset.html#results","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ResultSet"},{"id":22,"kind":128,"name":"SQLOptions","url":"classes/sqloptions.html","classes":"tsd-kind-class"},{"id":23,"kind":1024,"name":"autoGeneratedKeys","url":"classes/sqloptions.html#autogeneratedkeys","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":24,"kind":1024,"name":"autoGeneratedKeysIndexes","url":"classes/sqloptions.html#autogeneratedkeysindexes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":25,"kind":1024,"name":"catalog","url":"classes/sqloptions.html#catalog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":26,"kind":1024,"name":"fetchDirection","url":"classes/sqloptions.html#fetchdirection","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":27,"kind":1024,"name":"fetchSize","url":"classes/sqloptions.html#fetchsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":28,"kind":1024,"name":"queryTimeout","url":"classes/sqloptions.html#querytimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":29,"kind":1024,"name":"readOnly","url":"classes/sqloptions.html#readonly","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":30,"kind":1024,"name":"resultSetConcurrency","url":"classes/sqloptions.html#resultsetconcurrency","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":31,"kind":1024,"name":"resultSetType","url":"classes/sqloptions.html#resultsettype","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":32,"kind":1024,"name":"schema","url":"classes/sqloptions.html#schema","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":33,"kind":1024,"name":"transactionIsolation","url":"classes/sqloptions.html#transactionisolation","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SQLOptions"},{"id":34,"kind":128,"name":"UpdateResult","url":"classes/updateresult.html","classes":"tsd-kind-class"},{"id":35,"kind":1024,"name":"keys","url":"classes/updateresult.html#keys","classes":"tsd-kind-property tsd-parent-kind-class","parent":"UpdateResult"},{"id":36,"kind":1024,"name":"updated","url":"classes/updateresult.html#updated","classes":"tsd-kind-property tsd-parent-kind-class","parent":"UpdateResult"},{"id":37,"kind":128,"name":"SQLClient","url":"classes/sqlclient.html","classes":"tsd-kind-class"},{"id":38,"kind":2048,"name":"querySingle","url":"classes/sqlclient.html#querysingle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":39,"kind":2048,"name":"querySingleWithParams","url":"classes/sqlclient.html#querysinglewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":40,"kind":2048,"name":"getConnection","url":"classes/sqlclient.html#getconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":41,"kind":2048,"name":"close","url":"classes/sqlclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":42,"kind":2048,"name":"query","url":"classes/sqlclient.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":43,"kind":2048,"name":"queryWithParams","url":"classes/sqlclient.html#querywithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":44,"kind":2048,"name":"update","url":"classes/sqlclient.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":45,"kind":2048,"name":"updateWithParams","url":"classes/sqlclient.html#updatewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":46,"kind":2048,"name":"call","url":"classes/sqlclient.html#call","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":47,"kind":2048,"name":"callWithParams","url":"classes/sqlclient.html#callwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":48,"kind":128,"name":"SQLConnection","url":"classes/sqlconnection.html","classes":"tsd-kind-class"},{"id":49,"kind":2048,"name":"querySingle","url":"classes/sqlconnection.html#querysingle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":50,"kind":2048,"name":"querySingleWithParams","url":"classes/sqlconnection.html#querysinglewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":51,"kind":2048,"name":"setOptions","url":"classes/sqlconnection.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":52,"kind":2048,"name":"setAutoCommit","url":"classes/sqlconnection.html#setautocommit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":53,"kind":2048,"name":"execute","url":"classes/sqlconnection.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":54,"kind":2048,"name":"query","url":"classes/sqlconnection.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":55,"kind":2048,"name":"queryStream","url":"classes/sqlconnection.html#querystream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":56,"kind":2048,"name":"queryWithParams","url":"classes/sqlconnection.html#querywithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":57,"kind":2048,"name":"queryStreamWithParams","url":"classes/sqlconnection.html#querystreamwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":58,"kind":2048,"name":"update","url":"classes/sqlconnection.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":59,"kind":2048,"name":"updateWithParams","url":"classes/sqlconnection.html#updatewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":60,"kind":2048,"name":"call","url":"classes/sqlconnection.html#call","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":61,"kind":2048,"name":"callWithParams","url":"classes/sqlconnection.html#callwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":62,"kind":2048,"name":"close","url":"classes/sqlconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":63,"kind":2048,"name":"commit","url":"classes/sqlconnection.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":64,"kind":2048,"name":"rollback","url":"classes/sqlconnection.html#rollback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":65,"kind":2048,"name":"setQueryTimeout","url":"classes/sqlconnection.html#setquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":66,"kind":2048,"name":"batch","url":"classes/sqlconnection.html#batch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":67,"kind":2048,"name":"batchWithParams","url":"classes/sqlconnection.html#batchwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":68,"kind":2048,"name":"batchCallableWithParams","url":"classes/sqlconnection.html#batchcallablewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":69,"kind":2048,"name":"setTransactionIsolation","url":"classes/sqlconnection.html#settransactionisolation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":70,"kind":2048,"name":"getTransactionIsolation","url":"classes/sqlconnection.html#gettransactionisolation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":71,"kind":256,"name":"SQLOperations","url":"interfaces/sqloperations.html","classes":"tsd-kind-interface"},{"id":72,"kind":2048,"name":"query","url":"interfaces/sqloperations.html#query","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":73,"kind":2048,"name":"queryWithParams","url":"interfaces/sqloperations.html#querywithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":74,"kind":2048,"name":"querySingle","url":"interfaces/sqloperations.html#querysingle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":75,"kind":2048,"name":"querySingleWithParams","url":"interfaces/sqloperations.html#querysinglewithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":76,"kind":2048,"name":"update","url":"interfaces/sqloperations.html#update","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":77,"kind":2048,"name":"updateWithParams","url":"interfaces/sqloperations.html#updatewithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":78,"kind":2048,"name":"call","url":"interfaces/sqloperations.html#call","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":79,"kind":2048,"name":"callWithParams","url":"interfaces/sqloperations.html#callwithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":80,"kind":128,"name":"SQLRowStream","url":"classes/sqlrowstream.html","classes":"tsd-kind-class"},{"id":81,"kind":2048,"name":"exceptionHandler","url":"classes/sqlrowstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":82,"kind":2048,"name":"handler","url":"classes/sqlrowstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":83,"kind":2048,"name":"pause","url":"classes/sqlrowstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":84,"kind":2048,"name":"resume","url":"classes/sqlrowstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":85,"kind":2048,"name":"endHandler","url":"classes/sqlrowstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":86,"kind":2048,"name":"column","url":"classes/sqlrowstream.html#column","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":87,"kind":2048,"name":"columns","url":"classes/sqlrowstream.html#columns","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":88,"kind":2048,"name":"resultSetClosedHandler","url":"classes/sqlrowstream.html#resultsetclosedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":89,"kind":2048,"name":"moreResults","url":"classes/sqlrowstream.html#moreresults","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":90,"kind":2048,"name":"close","url":"classes/sqlrowstream.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"}]}; \ No newline at end of file diff --git a/docs/@vertx/sql-common/assets/css/main.css b/docs/@vertx/sql/assets/css/main.css similarity index 100% rename from docs/@vertx/sql-common/assets/css/main.css rename to docs/@vertx/sql/assets/css/main.css diff --git a/docs/@vertx/sql-common/assets/css/main.css.map b/docs/@vertx/sql/assets/css/main.css.map similarity index 100% rename from docs/@vertx/sql-common/assets/css/main.css.map rename to docs/@vertx/sql/assets/css/main.css.map diff --git a/docs/@vertx/sql-common/assets/images/icons.png b/docs/@vertx/sql/assets/images/icons.png similarity index 100% rename from docs/@vertx/sql-common/assets/images/icons.png rename to docs/@vertx/sql/assets/images/icons.png diff --git a/docs/@vertx/sql-common/assets/images/icons@2x.png b/docs/@vertx/sql/assets/images/icons@2x.png similarity index 100% rename from docs/@vertx/sql-common/assets/images/icons@2x.png rename to docs/@vertx/sql/assets/images/icons@2x.png diff --git a/docs/@vertx/sql-common/assets/images/widgets.png b/docs/@vertx/sql/assets/images/widgets.png similarity index 100% rename from docs/@vertx/sql-common/assets/images/widgets.png rename to docs/@vertx/sql/assets/images/widgets.png diff --git a/docs/@vertx/sql-common/assets/images/widgets@2x.png b/docs/@vertx/sql/assets/images/widgets@2x.png similarity index 100% rename from docs/@vertx/sql-common/assets/images/widgets@2x.png rename to docs/@vertx/sql/assets/images/widgets@2x.png diff --git a/docs/@vertx/sql-common/assets/js/main.js b/docs/@vertx/sql/assets/js/main.js similarity index 100% rename from docs/@vertx/sql-common/assets/js/main.js rename to docs/@vertx/sql/assets/js/main.js diff --git a/docs/@vertx/sql/assets/js/search.js b/docs/@vertx/sql/assets/js/search.js new file mode 100644 index 000000000..da31bc42e --- /dev/null +++ b/docs/@vertx/sql/assets/js/search.js @@ -0,0 +1,3 @@ +var typedoc = typedoc || {}; + typedoc.search = typedoc.search || {}; + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","256":"Interface","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"FetchDirection","url":"enums/fetchdirection.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"FORWARD","url":"enums/fetchdirection.html#forward","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"FetchDirection"},{"id":2,"kind":16,"name":"REVERSE","url":"enums/fetchdirection.html#reverse","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"FetchDirection"},{"id":3,"kind":16,"name":"UNKNOWN","url":"enums/fetchdirection.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"FetchDirection"},{"id":4,"kind":4,"name":"ResultSetConcurrency","url":"enums/resultsetconcurrency.html","classes":"tsd-kind-enum"},{"id":5,"kind":16,"name":"READ_ONLY","url":"enums/resultsetconcurrency.html#read_only","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetConcurrency"},{"id":6,"kind":16,"name":"UPDATABLE","url":"enums/resultsetconcurrency.html#updatable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetConcurrency"},{"id":7,"kind":4,"name":"ResultSetType","url":"enums/resultsettype.html","classes":"tsd-kind-enum"},{"id":8,"kind":16,"name":"FORWARD_ONLY","url":"enums/resultsettype.html#forward_only","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetType"},{"id":9,"kind":16,"name":"SCROLL_INSENSITIVE","url":"enums/resultsettype.html#scroll_insensitive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetType"},{"id":10,"kind":16,"name":"SCROLL_SENSITIVE","url":"enums/resultsettype.html#scroll_sensitive","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ResultSetType"},{"id":11,"kind":4,"name":"TransactionIsolation","url":"enums/transactionisolation.html","classes":"tsd-kind-enum"},{"id":12,"kind":16,"name":"READ_UNCOMMITTED","url":"enums/transactionisolation.html#read_uncommitted","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":13,"kind":16,"name":"READ_COMMITTED","url":"enums/transactionisolation.html#read_committed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":14,"kind":16,"name":"REPEATABLE_READ","url":"enums/transactionisolation.html#repeatable_read","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":15,"kind":16,"name":"SERIALIZABLE","url":"enums/transactionisolation.html#serializable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":16,"kind":16,"name":"NONE","url":"enums/transactionisolation.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"TransactionIsolation"},{"id":17,"kind":128,"name":"ResultSet","url":"classes/resultset.html","classes":"tsd-kind-class"},{"id":18,"kind":512,"name":"constructor","url":"classes/resultset.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ResultSet"},{"id":19,"kind":2048,"name":"getColumnNames","url":"classes/resultset.html#getcolumnnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":20,"kind":2048,"name":"setColumnNames","url":"classes/resultset.html#setcolumnnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":21,"kind":2048,"name":"getNext","url":"classes/resultset.html#getnext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":22,"kind":2048,"name":"setNext","url":"classes/resultset.html#setnext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":23,"kind":2048,"name":"getNumColumns","url":"classes/resultset.html#getnumcolumns","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":24,"kind":2048,"name":"getNumRows","url":"classes/resultset.html#getnumrows","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":25,"kind":2048,"name":"getOutput","url":"classes/resultset.html#getoutput","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":26,"kind":2048,"name":"setOutput","url":"classes/resultset.html#setoutput","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":27,"kind":2048,"name":"getResults","url":"classes/resultset.html#getresults","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":28,"kind":2048,"name":"setResults","url":"classes/resultset.html#setresults","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":29,"kind":2048,"name":"getRows","url":"classes/resultset.html#getrows","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResultSet"},{"id":30,"kind":128,"name":"SQLOptions","url":"classes/sqloptions.html","classes":"tsd-kind-class"},{"id":31,"kind":512,"name":"constructor","url":"classes/sqloptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SQLOptions"},{"id":32,"kind":2048,"name":"isAutoGeneratedKeys","url":"classes/sqloptions.html#isautogeneratedkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":33,"kind":2048,"name":"setAutoGeneratedKeys","url":"classes/sqloptions.html#setautogeneratedkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":34,"kind":2048,"name":"getAutoGeneratedKeysIndexes","url":"classes/sqloptions.html#getautogeneratedkeysindexes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":35,"kind":2048,"name":"setAutoGeneratedKeysIndexes","url":"classes/sqloptions.html#setautogeneratedkeysindexes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":36,"kind":2048,"name":"getCatalog","url":"classes/sqloptions.html#getcatalog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":37,"kind":2048,"name":"setCatalog","url":"classes/sqloptions.html#setcatalog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":38,"kind":2048,"name":"getFetchDirection","url":"classes/sqloptions.html#getfetchdirection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":39,"kind":2048,"name":"setFetchDirection","url":"classes/sqloptions.html#setfetchdirection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":40,"kind":2048,"name":"getFetchSize","url":"classes/sqloptions.html#getfetchsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":41,"kind":2048,"name":"setFetchSize","url":"classes/sqloptions.html#setfetchsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":42,"kind":2048,"name":"getQueryTimeout","url":"classes/sqloptions.html#getquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":43,"kind":2048,"name":"setQueryTimeout","url":"classes/sqloptions.html#setquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":44,"kind":2048,"name":"isReadOnly","url":"classes/sqloptions.html#isreadonly","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":45,"kind":2048,"name":"setReadOnly","url":"classes/sqloptions.html#setreadonly","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":46,"kind":2048,"name":"getResultSetConcurrency","url":"classes/sqloptions.html#getresultsetconcurrency","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":47,"kind":2048,"name":"setResultSetConcurrency","url":"classes/sqloptions.html#setresultsetconcurrency","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":48,"kind":2048,"name":"getResultSetType","url":"classes/sqloptions.html#getresultsettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":49,"kind":2048,"name":"setResultSetType","url":"classes/sqloptions.html#setresultsettype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":50,"kind":2048,"name":"getSchema","url":"classes/sqloptions.html#getschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":51,"kind":2048,"name":"setSchema","url":"classes/sqloptions.html#setschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":52,"kind":2048,"name":"getTransactionIsolation","url":"classes/sqloptions.html#gettransactionisolation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":53,"kind":2048,"name":"setTransactionIsolation","url":"classes/sqloptions.html#settransactionisolation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLOptions"},{"id":54,"kind":128,"name":"UpdateResult","url":"classes/updateresult.html","classes":"tsd-kind-class"},{"id":55,"kind":512,"name":"constructor","url":"classes/updateresult.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"UpdateResult"},{"id":56,"kind":2048,"name":"getKeys","url":"classes/updateresult.html#getkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UpdateResult"},{"id":57,"kind":2048,"name":"setKeys","url":"classes/updateresult.html#setkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UpdateResult"},{"id":58,"kind":2048,"name":"getUpdated","url":"classes/updateresult.html#getupdated","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UpdateResult"},{"id":59,"kind":2048,"name":"setUpdated","url":"classes/updateresult.html#setupdated","classes":"tsd-kind-method tsd-parent-kind-class","parent":"UpdateResult"},{"id":60,"kind":128,"name":"SQLClient","url":"classes/sqlclient.html","classes":"tsd-kind-class"},{"id":61,"kind":2048,"name":"querySingle","url":"classes/sqlclient.html#querysingle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":62,"kind":2048,"name":"querySingleWithParams","url":"classes/sqlclient.html#querysinglewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":63,"kind":2048,"name":"getConnection","url":"classes/sqlclient.html#getconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":64,"kind":2048,"name":"close","url":"classes/sqlclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":65,"kind":2048,"name":"query","url":"classes/sqlclient.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":66,"kind":2048,"name":"queryStream","url":"classes/sqlclient.html#querystream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":67,"kind":2048,"name":"queryStreamWithParams","url":"classes/sqlclient.html#querystreamwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":68,"kind":2048,"name":"queryWithParams","url":"classes/sqlclient.html#querywithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":69,"kind":2048,"name":"update","url":"classes/sqlclient.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":70,"kind":2048,"name":"updateWithParams","url":"classes/sqlclient.html#updatewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":71,"kind":2048,"name":"call","url":"classes/sqlclient.html#call","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":72,"kind":2048,"name":"callWithParams","url":"classes/sqlclient.html#callwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLClient"},{"id":73,"kind":128,"name":"SQLConnection","url":"classes/sqlconnection.html","classes":"tsd-kind-class"},{"id":74,"kind":2048,"name":"querySingle","url":"classes/sqlconnection.html#querysingle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":75,"kind":2048,"name":"querySingleWithParams","url":"classes/sqlconnection.html#querysinglewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":76,"kind":2048,"name":"setOptions","url":"classes/sqlconnection.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":77,"kind":2048,"name":"setAutoCommit","url":"classes/sqlconnection.html#setautocommit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":78,"kind":2048,"name":"execute","url":"classes/sqlconnection.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":79,"kind":2048,"name":"query","url":"classes/sqlconnection.html#query","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":80,"kind":2048,"name":"queryStream","url":"classes/sqlconnection.html#querystream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":81,"kind":2048,"name":"queryWithParams","url":"classes/sqlconnection.html#querywithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":82,"kind":2048,"name":"queryStreamWithParams","url":"classes/sqlconnection.html#querystreamwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":83,"kind":2048,"name":"update","url":"classes/sqlconnection.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":84,"kind":2048,"name":"updateWithParams","url":"classes/sqlconnection.html#updatewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":85,"kind":2048,"name":"call","url":"classes/sqlconnection.html#call","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":86,"kind":2048,"name":"callWithParams","url":"classes/sqlconnection.html#callwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":87,"kind":2048,"name":"close","url":"classes/sqlconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":88,"kind":2048,"name":"commit","url":"classes/sqlconnection.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":89,"kind":2048,"name":"rollback","url":"classes/sqlconnection.html#rollback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":90,"kind":2048,"name":"setQueryTimeout","url":"classes/sqlconnection.html#setquerytimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":91,"kind":2048,"name":"batch","url":"classes/sqlconnection.html#batch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":92,"kind":2048,"name":"batchWithParams","url":"classes/sqlconnection.html#batchwithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":93,"kind":2048,"name":"batchCallableWithParams","url":"classes/sqlconnection.html#batchcallablewithparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":94,"kind":2048,"name":"setTransactionIsolation","url":"classes/sqlconnection.html#settransactionisolation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":95,"kind":2048,"name":"getTransactionIsolation","url":"classes/sqlconnection.html#gettransactionisolation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLConnection"},{"id":96,"kind":256,"name":"SQLOperations","url":"interfaces/sqloperations.html","classes":"tsd-kind-interface"},{"id":97,"kind":2048,"name":"query","url":"interfaces/sqloperations.html#query","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":98,"kind":2048,"name":"queryWithParams","url":"interfaces/sqloperations.html#querywithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":99,"kind":2048,"name":"queryStream","url":"interfaces/sqloperations.html#querystream","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":100,"kind":2048,"name":"queryStreamWithParams","url":"interfaces/sqloperations.html#querystreamwithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":101,"kind":2048,"name":"querySingle","url":"interfaces/sqloperations.html#querysingle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":102,"kind":2048,"name":"querySingleWithParams","url":"interfaces/sqloperations.html#querysinglewithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":103,"kind":2048,"name":"update","url":"interfaces/sqloperations.html#update","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":104,"kind":2048,"name":"updateWithParams","url":"interfaces/sqloperations.html#updatewithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":105,"kind":2048,"name":"call","url":"interfaces/sqloperations.html#call","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":106,"kind":2048,"name":"callWithParams","url":"interfaces/sqloperations.html#callwithparams","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"SQLOperations"},{"id":107,"kind":128,"name":"SQLRowStream","url":"classes/sqlrowstream.html","classes":"tsd-kind-class"},{"id":108,"kind":2048,"name":"fetch","url":"classes/sqlrowstream.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":109,"kind":2048,"name":"exceptionHandler","url":"classes/sqlrowstream.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":110,"kind":2048,"name":"handler","url":"classes/sqlrowstream.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":111,"kind":2048,"name":"pause","url":"classes/sqlrowstream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":112,"kind":2048,"name":"resume","url":"classes/sqlrowstream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":113,"kind":2048,"name":"endHandler","url":"classes/sqlrowstream.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":114,"kind":2048,"name":"column","url":"classes/sqlrowstream.html#column","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":115,"kind":2048,"name":"columns","url":"classes/sqlrowstream.html#columns","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":116,"kind":2048,"name":"resultSetClosedHandler","url":"classes/sqlrowstream.html#resultsetclosedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":117,"kind":2048,"name":"moreResults","url":"classes/sqlrowstream.html#moreresults","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"},{"id":118,"kind":2048,"name":"close","url":"classes/sqlrowstream.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SQLRowStream"}]}; \ No newline at end of file diff --git a/docs/@vertx/sql/classes/resultset.html b/docs/@vertx/sql/classes/resultset.html new file mode 100644 index 000000000..09aeee5ec --- /dev/null +++ b/docs/@vertx/sql/classes/resultset.html @@ -0,0 +1,588 @@ + + + + + + ResultSet | @vertx/sql + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class ResultSet

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + ResultSet +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns ResultSet

      +
      • +
    • + +

      Parameters

      + +

      Returns ResultSet

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    getColumnNames

    +
      +
    • getColumnNames(): string
      • +
    +
      +
    • + +
      +
      +

      Get the column names

      +
      +
      +

      Returns string

      +

      the column names

      +
      • +
    +
    +
    + +

    getNext

    + +
      +
    • + +
      +
      +

      Get the next result set

      +
      +
      +

      Returns ResultSet

      +

      the next resultset

      +
      • +
    +
    +
    + +

    getNumColumns

    +
      +
    • getNumColumns(): number
      • +
    +
      +
    • + +
      +
      +

      Return the number of columns in the result set

      +
      +
      +

      Returns number

      +

      the number of columns

      +
      • +
    +
    +
    + +

    getNumRows

    +
      +
    • getNumRows(): number
      • +
    +
      +
    • + +
      +
      +

      Return the number of rows in the result set

      +
      +
      +

      Returns number

      +

      the number of rows

      +
      • +
    +
    +
    + +

    getOutput

    +
      +
    • getOutput(): any[]
      • +
    +
      +
    • + +
      +
      +

      Get the registered outputs

      +
      +
      +

      Returns any[]

      +

      the outputs

      +
      • +
    +
    +
    + +

    getResults

    +
      +
    • getResults(): any[]
      • +
    +
      +
    • + +
      +
      +

      Get the results

      +
      +
      +

      Returns any[]

      +

      the results

      +
      • +
    +
    +
    + +

    getRows

    +
      +
    • getRows(): object
      • +
    +
      +
    • + +
      +
      +

      Get the rows - each row represented as a JsonObject where the keys are the column names and the values are + the column values.

      +
      +

      Beware that it's legal for a query result in SQL to contain duplicate column names, in which case one will + overwrite the other if using this method. If that's the case use {@link #getResults} instead.

      +

      Be aware that column names are defined as returned by the database, this means that even if your SQL statement + is for example: 

      SELECT a, b FROM table
      the column names are not required to be: 
      a
      and + 
      b
      and could be in fact 
      A
      and 
      B
      .

      +

      For cases when there is the need for case insentivitity you should see {@link #getRows(boolean)}

      +
      +

      Returns object

      +

      the rows represented as JSON object instances

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    +
    + +

    setColumnNames

    +
      +
    • setColumnNames(columnNames: string): ResultSet
      • +
    +
      +
    • + +
      +
      +

      Get the column names

      +
      +
      +

      Parameters

      +
        +
      • +
        columnNames: string
        +
        • +
      +

      Returns ResultSet

      +

      the column names

      +
      • +
    +
    +
    + +

    setNext

    + +
      +
    • + +
      +
      +

      Get the next result set

      +
      +
      +

      Parameters

      + +

      Returns ResultSet

      +

      the next resultset

      +
      • +
    +
    +
    + +

    setOutput

    + +
      +
    • + +
      +
      +

      Get the registered outputs

      +
      +
      +

      Parameters

      +
        +
      • +
        output: any[]
        +
        • +
      +

      Returns ResultSet

      +

      the outputs

      +
      • +
    +
    +
    + +

    setResults

    + +
      +
    • + +
      +
      +

      Get the results

      +
      +
      +

      Parameters

      +
        +
      • +
        results: any[]
        +
        • +
      +

      Returns ResultSet

      +

      the results

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/sql-common/classes/sqlclient.html b/docs/@vertx/sql/classes/sqlclient.html similarity index 59% rename from docs/@vertx/sql-common/classes/sqlclient.html rename to docs/@vertx/sql/classes/sqlclient.html index 1b7f123b2..e8f36c9e6 100644 --- a/docs/@vertx/sql-common/classes/sqlclient.html +++ b/docs/@vertx/sql/classes/sqlclient.html @@ -3,7 +3,7 @@ - SQLClient | @vertx/sql-common + SQLClient | @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -72,6 +72,12 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -86,6 +92,8 @@

    Methods

  • query
  • querySingle
  • querySingleWithParams
    • +
  • queryStream
    • +
  • queryStreamWithParams
  • queryWithParams
  • update
  • updateWithParams
    • @@ -106,12 +114,12 @@

    call

  • -

    Calls the given SQL PROCEDURE which returns the result from the procedure.

    +

    Calls the given SQL PROCEDURE which returns the result from the procedure.

    see
    @@ -135,17 +143,20 @@
    handler: function

      • Parameters

        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<ResultSet>> +

      • @@ -166,12 +177,12 @@

      callWithParams

    • -

      Calls the given SQL PROCEDURE which returns the result from the procedure.

      +

      Calls the given SQL PROCEDURE which returns the result from the procedure.

      The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:

      @@ -213,17 +224,20 @@
      handler: function

        • Parameters

          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<ResultSet>> +

        • @@ -245,12 +259,12 @@

        close

      • -

        Close the client and release all resources. +

        Close the client and release all resources. Call the handler when close is complete.

        @@ -264,17 +278,20 @@
        handler: function
          • -
          • (result: AsyncResult<void>): void
            • +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

          • Parameters

            • -
              result: AsyncResult<void>
              +
              res: AsyncResult<void>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<void>> +

          • @@ -286,12 +303,12 @@

          Returns void
          -

          Close the client

          +

          Close the client

          Returns void

          @@ -308,12 +325,12 @@

          getConnection

        • -

          Returns a connection that can be used to perform SQL operations on. It's important to remember +

          Returns a connection that can be used to perform SQL operations on. It's important to remember to close the connection when you are done, so it is returned to the pool.

          @@ -327,17 +344,20 @@
          handler: function
            • @@ -358,12 +378,12 @@

            query

          • -

            Execute a single SQL statement, this method acquires a connection from the the pool and executes the SQL +

            Execute a single SQL statement, this method acquires a connection from the the pool and executes the SQL statement and returns it back after the execution.

            @@ -383,17 +403,20 @@
            handler: function

              • Parameters

                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<ResultSet>> +

              • @@ -415,12 +438,12 @@

              querySingle

            • -

              Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by +

              Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

              @@ -441,17 +464,20 @@
              handler: function
                • -
                • (result: AsyncResult<any[]>): void
                  • +
                • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                • Parameters

                  • -
                    result: AsyncResult<any[]>
                    +
                    res: AsyncResult<any[]>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<any[]>> +

                • @@ -473,12 +499,12 @@

                querySingleWithParams

              • -

                Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the +

                Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

                @@ -505,17 +531,20 @@
                handler: function
                  • -
                  • (result: AsyncResult<any[]>): void
                    • +
                  • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                  • Parameters

                    • -
                      result: AsyncResult<any[]>
                      +
                      res: AsyncResult<any[]>
                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<any[]>> +

                  • @@ -527,6 +556,144 @@

                  Returns

    • +
    + +

    queryStream

    +
      +
    • queryStream(sql: string, handler: function): SQLClient
      • +
    +
      +
    • + +
      +
      +

      Executes the given SQL SELECT statement which returns the results of the query as a read stream.

      +
      +
      +
      see
      +

      java.sql.Statement#executeQuery(String)

      +
      +
      see
      +

      java.sql.PreparedStatement#executeQuery(String)

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        sql: string
        +
        +

        the SQL to execute. For example SELECT * FROM table ....

        +
        +
        • +
      • +
        handler: function
        +
        +

        the handler which is called once the operation completes. It will return a {@code SQLRowStream}.

        +
        + +
        • +
      +

      Returns SQLClient

      +
      • +
    +
    +
    + +

    queryStreamWithParams

    +
      +
    • queryStreamWithParams(sql: string, params: any[], handler: function): SQLClient
      • +
    +
      +
    • + +
      +
      +

      Executes the given SQL SELECT statement which returns the results of the query as a read stream.

      +
      +
      +
      see
      +

      java.sql.Statement#executeQuery(String)

      +
      +
      see
      +

      java.sql.PreparedStatement#executeQuery(String)

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        sql: string
        +
        +

        the SQL to execute. For example SELECT * FROM table ....

        +
        +
        • +
      • +
        params: any[]
        +
        +

        these are the parameters to fill the statement.

        +
        +
        • +
      • +
        handler: function
        +
        +

        the handler which is called once the operation completes. It will return a {@code SQLRowStream}.

        +
        + +
        • +
      +

      Returns SQLClient

      +
      • +
    +

    queryWithParams

    @@ -537,12 +704,12 @@

    queryWithParams

  • -

    Execute a single SQL prepared statement, this method acquires a connection from the the pool and executes the SQL +

    Execute a single SQL prepared statement, this method acquires a connection from the the pool and executes the SQL prepared statement and returns it back after the execution.

    @@ -568,17 +735,20 @@
    handler: function

      • Parameters

        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<ResultSet>> +

      • @@ -600,12 +770,12 @@

      update

    • -

      Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE +

      Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

      @@ -633,17 +803,20 @@
      handler: function
        • @@ -664,12 +837,12 @@

        updateWithParams

      • -

        Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE +

        Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

        @@ -703,17 +876,20 @@
        handler: function
          • @@ -777,6 +953,12 @@

          Returns querySingleWithParams +
        • + queryStream +
          • +
        • + queryStreamWithParams +
        • queryWithParams
          • diff --git a/docs/@vertx/sql-common/classes/sqlconnection.html b/docs/@vertx/sql/classes/sqlconnection.html similarity index 68% rename from docs/@vertx/sql-common/classes/sqlconnection.html rename to docs/@vertx/sql/classes/sqlconnection.html index b23fa0d25..746308039 100644 --- a/docs/@vertx/sql-common/classes/sqlconnection.html +++ b/docs/@vertx/sql/classes/sqlconnection.html @@ -3,7 +3,7 @@ - SQLConnection | @vertx/sql-common + SQLConnection | @vertx/sql @@ -22,7 +22,7 @@
        • Preparing search index...
        • The search index is not available

        - @vertx/sql-common + @vertx/sql
        @@ -72,6 +72,12 @@

        Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -118,12 +124,12 @@

    batch

  • -

    Batch simple SQL strings and execute the batch where the async result contains a array of Integers.

    +

    Batch simple SQL strings and execute the batch where the async result contains a array of Integers.

    Parameters

    @@ -142,17 +148,20 @@
    handler: function
      • -
      • (result: AsyncResult<number[]>): void
        • +
      • (res: AsyncResult<number[]>): void | Handler<AsyncResult<number[]>>

      • Parameters

        • -
          result: AsyncResult<number[]>
          +
          res: AsyncResult<number[]>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<number[]>> +

      • @@ -173,12 +182,12 @@

      batchCallableWithParams

    • -

      Batch a callable statement with all entries from the args list. Each entry is a batch. +

      Batch a callable statement with all entries from the args list. Each entry is a batch. The size of the lists inArgs and outArgs MUST be the equal. The operation completes with the execution of the batch where the async result contains a array of Integers.

      @@ -211,17 +220,20 @@
      handler: function
        • -
        • (result: AsyncResult<number[]>): void
          • +
        • (res: AsyncResult<number[]>): void | Handler<AsyncResult<number[]>>

        • Parameters

          • -
            result: AsyncResult<number[]>
            +
            res: AsyncResult<number[]>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<number[]>> +

        • @@ -242,12 +254,12 @@

        batchWithParams

      • -

        Batch a prepared statement with all entries from the args list. Each entry is a batch. +

        Batch a prepared statement with all entries from the args list. Each entry is a batch. The operation completes with the execution of the batch where the async result contains a array of Integers.

        @@ -273,17 +285,20 @@
        handler: function
          • -
          • (result: AsyncResult<number[]>): void
            • +
          • (res: AsyncResult<number[]>): void | Handler<AsyncResult<number[]>>

          • Parameters

            • -
              result: AsyncResult<number[]>
              +
              res: AsyncResult<number[]>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<number[]>> +

          • @@ -304,12 +319,12 @@

          call

        • -

          Calls the given SQL PROCEDURE which returns the result from the procedure.

          +

          Calls the given SQL PROCEDURE which returns the result from the procedure.

          see
          @@ -333,17 +348,20 @@
          resultHandler: function

            • Parameters

              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<ResultSet>> +

            • @@ -364,12 +382,12 @@

            callWithParams

          • -

            Calls the given SQL PROCEDURE which returns the result from the procedure.

            +

            Calls the given SQL PROCEDURE which returns the result from the procedure.

            The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:

            @@ -411,17 +429,20 @@
            resultHandler: function

              • Parameters

                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<ResultSet>> +

              • @@ -443,12 +464,12 @@

              close

            • -

              Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

              +

              Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

              Parameters

              @@ -461,17 +482,20 @@
              handler: function
                • -
                • (result: AsyncResult<void>): void
                  • +
                • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                • Parameters

                  • -
                    result: AsyncResult<void>
                    +
                    res: AsyncResult<void>
                  -

                  Returns void

                  +

                  Returns void + | + Handler<AsyncResult<void>> +

                • @@ -483,12 +507,12 @@

                Returns void
                -

                Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

                +

                Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

                Returns void

                @@ -505,12 +529,12 @@

                commit

              • -

                Commits all changes made since the previous commit/rollback.

                +

                Commits all changes made since the previous commit/rollback.

                Parameters

                @@ -523,17 +547,20 @@
                handler: function
                  • -
                  • (result: AsyncResult<void>): void
                    • +
                  • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                  • Parameters

                    • -
                      result: AsyncResult<void>
                      +
                      res: AsyncResult<void>
                    -

                    Returns void

                    +

                    Returns void + | + Handler<AsyncResult<void>> +

                  • @@ -554,12 +581,12 @@

                  execute

                • -

                  Executes the given SQL statement

                  +

                  Executes the given SQL statement

                  see
                  @@ -583,17 +610,20 @@
                  resultHandler: function
                    • -
                    • (result: AsyncResult<void>): void
                      • +
                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                    • Parameters

                      • -
                        result: AsyncResult<void>
                        +
                        res: AsyncResult<void>
                      -

                      Returns void

                      +

                      Returns void + | + Handler<AsyncResult<void>> +

                    • @@ -614,12 +644,12 @@

                    getTransactionIsolation

                  • -

                    Attempts to return the transaction isolation level for this Connection object to the one given.

                    +

                    Attempts to return the transaction isolation level for this Connection object to the one given.

                    Parameters

                    @@ -632,17 +662,20 @@
                    handler: function
                      • @@ -663,12 +696,12 @@

                      query

                    • -

                      Executes the given SQL SELECT statement which returns the results of the query.

                      +

                      Executes the given SQL SELECT statement which returns the results of the query.

                      see
                      @@ -695,17 +728,20 @@
                      resultHandler: function

                        • Parameters

                          -

                          Returns void

                          +

                          Returns void + | + Handler<AsyncResult<ResultSet>> +

                        • @@ -726,12 +762,12 @@

                        querySingle

                      • -

                        Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by +

                        Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

                        @@ -752,17 +788,20 @@
                        handler: function
                          • -
                          • (result: AsyncResult<any[]>): void
                            • +
                          • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                          • Parameters

                            • -
                              result: AsyncResult<any[]>
                              +
                              res: AsyncResult<any[]>
                            -

                            Returns void

                            +

                            Returns void + | + Handler<AsyncResult<any[]>> +

                          • @@ -784,12 +823,12 @@

                          querySingleWithParams

                        • -

                          Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the +

                          Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

                          @@ -816,17 +855,20 @@
                          handler: function
                            • -
                            • (result: AsyncResult<any[]>): void
                              • +
                            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

                            • Parameters

                              • -
                                result: AsyncResult<any[]>
                                +
                                res: AsyncResult<any[]>
                              -

                              Returns void

                              +

                              Returns void + | + Handler<AsyncResult<any[]>> +

                            • @@ -848,12 +890,12 @@

                            queryStream

                          • -

                            Executes the given SQL SELECT statement which returns the results of the query as a read stream.

                            +

                            Executes the given SQL SELECT statement which returns the results of the query as a read stream.

                            see
                            @@ -880,17 +922,20 @@
                            handler: function
                              • @@ -911,12 +956,12 @@

                              queryStreamWithParams

                            • -

                              Executes the given SQL SELECT statement which returns the results of the query as a read stream.

                              +

                              Executes the given SQL SELECT statement which returns the results of the query as a read stream.

                              see
                              @@ -949,17 +994,20 @@
                              handler: function
                                • @@ -980,12 +1028,12 @@

                                queryWithParams

                              • -

                                Executes the given SQL SELECT prepared statement which returns the results of the query.

                                +

                                Executes the given SQL SELECT prepared statement which returns the results of the query.

                                see
                                @@ -1018,17 +1066,20 @@
                                resultHandler: function

                                  • Parameters

                                    -

                                    Returns void

                                    +

                                    Returns void + | + Handler<AsyncResult<ResultSet>> +

                                  • @@ -1049,12 +1100,12 @@

                                  rollback

                                • -

                                  Rolls back all changes made since the previous commit/rollback.

                                  +

                                  Rolls back all changes made since the previous commit/rollback.

                                  Parameters

                                  @@ -1067,17 +1118,20 @@
                                  handler: function
                                    • -
                                    • (result: AsyncResult<void>): void
                                      • +
                                    • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                    • Parameters

                                      • -
                                        result: AsyncResult<void>
                                        +
                                        res: AsyncResult<void>
                                      -

                                      Returns void

                                      +

                                      Returns void + | + Handler<AsyncResult<void>> +

                                    • @@ -1098,12 +1152,12 @@

                                    setAutoCommit

                                  • -

                                    Sets the auto commit flag for this connection. True by default.

                                    +

                                    Sets the auto commit flag for this connection. True by default.

                                    see
                                    @@ -1127,17 +1181,20 @@
                                    resultHandler: function
                                      • -
                                      • (result: AsyncResult<void>): void
                                        • +
                                      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                      • Parameters

                                        • -
                                          result: AsyncResult<void>
                                          +
                                          res: AsyncResult<void>
                                        -

                                        Returns void

                                        +

                                        Returns void + | + Handler<AsyncResult<void>> +

                                      • @@ -1158,12 +1215,12 @@

                                      setOptions

                                    • -

                                      Sets the desired options to be applied to the current connection when statements are executed.

                                      +

                                      Sets the desired options to be applied to the current connection when statements are executed.

                                      The options are not applied globally but applicable to the current connection. For example changing the transaction isolation level will only affect statements run on this connection and not future or current connections acquired @@ -1193,12 +1250,12 @@

                                      setQueryTimeout

                                    • -

                                      Sets a connection wide query timeout.

                                      +

                                      Sets a connection wide query timeout.

                                      It can be over written at any time and becomes active on the next query call.

                                      @@ -1225,12 +1282,12 @@

                                      setTransactionIsolation

                                    • -

                                      Attempts to change the transaction isolation level for this Connection object to the one given.

                                      +

                                      Attempts to change the transaction isolation level for this Connection object to the one given.

                                      The constants defined in the interface Connection are the possible transaction isolation levels.

                                      @@ -1250,17 +1307,20 @@
                                      handler: function
                                        • -
                                        • (result: AsyncResult<void>): void
                                          • +
                                        • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

                                        • Parameters

                                          • -
                                            result: AsyncResult<void>
                                            +
                                            res: AsyncResult<void>
                                          -

                                          Returns void

                                          +

                                          Returns void + | + Handler<AsyncResult<void>> +

                                        • @@ -1281,12 +1341,12 @@

                                        update

                                      • -

                                        Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE +

                                        Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

                                        @@ -1314,17 +1374,20 @@
                                        resultHandler: function

    • +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -84,6 +90,7 @@

    Methods

  • columns
  • endHandler
  • exceptionHandler
    • +
  • fetch
  • handler
  • moreResults
  • pause
    • @@ -107,12 +114,12 @@

    close

  • -

    Closes the stream/underlying cursor(s). The actual close happens asynchronously.

    +

    Closes the stream/underlying cursor(s). The actual close happens asynchronously.

    Returns void

    @@ -120,12 +127,12 @@

    Returns void
    -

    Closes the stream/underlying cursor(s). The actual close happens asynchronously.

    +

    Closes the stream/underlying cursor(s). The actual close happens asynchronously.

    Parameters

    @@ -138,17 +145,20 @@
    handler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -169,12 +179,12 @@

      column

    • -

      Will convert the column name to the json array index.

      +

      Will convert the column name to the json array index.

      Parameters

      @@ -201,12 +211,12 @@

      columns

    • -

      Returns all column names available in the underlying resultset. One needs to carefully use this method since in +

      Returns all column names available in the underlying resultset. One needs to carefully use this method since in contrast to the singular version it does not perform case insensitive lookups or takes alias in consideration on the column names.

      @@ -226,7 +236,7 @@

      endHandler

    • Parameters

      @@ -236,17 +246,19 @@
      endHandler: function
        • -
        • (result: void): void | null | undefined
          • +
        • (res: void): void | Handler<void> | null | undefined

        • Parameters

          • -
            result: void
            +
            res: void

          Returns void + | + Handler<void> | null | @@ -272,7 +284,7 @@

          exceptionHandler

        • Parameters

          @@ -282,17 +294,19 @@
          handler: function
            • -
            • (result: Error): void | null | undefined
              • +
            • (res: Error): void | Handler<Error> | null | undefined

            • Parameters

              • -
                result: Error
                +
                res: Error

              Returns void + | + Handler<Error> | null | @@ -308,6 +322,29 @@

              Returns + +

              fetch

              +
                +
              • fetch(arg0: number): ReadStream<any[]>
                • +
              +
                +
              • + +

                Parameters

                +
                  +
                • +
                  arg0: number
                  +
                  • +
                +

                Returns ReadStream<any[]>

                +
                • +
              +

    • handler

    @@ -318,7 +355,7 @@

    handler

  • Parameters

    @@ -328,17 +365,19 @@
    handler: function
      • -
      • (result: any[]): void | null | undefined
        • +
      • (res: any[]): void | Handler<any[]> | null | undefined

      • Parameters

        • -
          result: any[]
          +
          res: any[]

        Returns void + | + Handler<any[]> | null | @@ -364,12 +403,12 @@

        moreResults

      • -

        Request for more results if available

        +

        Request for more results if available

        Returns void

        @@ -386,7 +425,7 @@

        pause

      • Returns SQLRowStream

        @@ -403,12 +442,12 @@

        resultSetClosedHandler

      • -

        Event handler when a resultset is closed. This is useful to request for more results.

        +

        Event handler when a resultset is closed. This is useful to request for more results.

        Parameters

        @@ -421,17 +460,20 @@
        handler: function
          • -
          • (result: void): void
            • +
          • (res: void): void | Handler<void>

          • Parameters

            • -
              result: void
              +
              res: void
            -

            Returns void

            +

            Returns void + | + Handler<void> +

          • @@ -452,7 +494,7 @@

          resume

        • Returns SQLRowStream

          @@ -515,6 +557,9 @@

          Returns exceptionHandler

          • +
        • + fetch +
        • handler
          • diff --git a/docs/@vertx/sql-common/classes/sqloptions.html b/docs/@vertx/sql/classes/updateresult.html similarity index 51% rename from docs/@vertx/sql-common/classes/sqloptions.html rename to docs/@vertx/sql/classes/updateresult.html index f75dc7c8d..a98c25105 100644 --- a/docs/@vertx/sql-common/classes/sqloptions.html +++ b/docs/@vertx/sql/classes/updateresult.html @@ -3,7 +3,7 @@ - SQLOptions | @vertx/sql-common + UpdateResult | @vertx/sql @@ -22,7 +22,7 @@
        • Preparing search index...
        • The search index is not available
        - @vertx/sql-common + @vertx/sql
        @@ -54,10 +54,10 @@ Globals
      • - SQLOptions + UpdateResult
      -

      Class SQLOptions

      +

      Class UpdateResult

      @@ -68,7 +68,7 @@

      Class SQLOptions

      Hierarchy

      • - SQLOptions + UpdateResult
    • @@ -77,135 +77,163 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    autoGeneratedKeys

    -
    autoGeneratedKeys: boolean
    - -
    -
    - -

    autoGeneratedKeysIndexes

    -
    autoGeneratedKeysIndexes: any[]
    - -
    -
    - -

    catalog

    -
    catalog: string
    - -
    -
    - -

    fetchDirection

    -
    fetchDirection: FetchDirection
    - -
    -
    - -

    fetchSize

    -
    fetchSize: number
    - -
    -
    - -

    queryTimeout

    -
    queryTimeout: number
    - -
    -
    - -

    readOnly

    -
    readOnly: boolean
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    resultSetConcurrency

    -
    resultSetConcurrency: ResultSetConcurrency
    - +
    +
    +

    Methods

    +
    + +

    getKeys

    +
      +
    • getKeys(): any[]
      • +
    +
      +
    • + +
      +
      +

      Get any generated keys

      +
      +
      +

      Returns any[]

      +

      generated keys

      +
      • +
    -
    - -

    resultSetType

    -
    resultSetType: ResultSetType
    - +
    + +

    getUpdated

    +
      +
    • getUpdated(): number
      • +
    +
      +
    • + +
      +
      +

      Get the number of rows updated

      +
      +
      +

      Returns number

      +

      number of rows updated

      +
      • +
    -
    - -

    schema

    -
    schema: string
    - +
    + +

    setKeys

    + +
      +
    • + +
      +
      +

      Get any generated keys

      +
      +
      +

      Parameters

      +
        +
      • +
        keys: any[]
        +
        • +
      +

      Returns UpdateResult

      +

      generated keys

      +
      • +
    -
    - -

    transactionIsolation

    -
    transactionIsolation: TransactionIsolation
    - +
    + +

    setUpdated

    + +
      +
    • + +
      +
      +

      Get the number of rows updated

      +
      +
      +

      Parameters

      +
        +
      • +
        updated: number
        +
        • +
      +

      Returns UpdateResult

      +

      number of rows updated

      +
      • +
    @@ -240,54 +268,36 @@

    transactionIsolation

  • SQLConnection
    • +
  • + SQLOptions +
    • +
  • + SQLRowStream +
      • -
    • - SQLRowStream -
      • -
    • - UpdateResult -
    • SQLOperations
      • diff --git a/docs/@vertx/sql-common/enums/fetchdirection.html b/docs/@vertx/sql/enums/fetchdirection.html similarity index 97% rename from docs/@vertx/sql-common/enums/fetchdirection.html rename to docs/@vertx/sql/enums/fetchdirection.html index 695597806..9890eadd5 100644 --- a/docs/@vertx/sql-common/enums/fetchdirection.html +++ b/docs/@vertx/sql/enums/fetchdirection.html @@ -3,7 +3,7 @@ - FetchDirection | @vertx/sql-common + FetchDirection | @vertx/sql @@ -22,7 +22,7 @@
    • Preparing search index...
    • The search index is not available
    - @vertx/sql-common + @vertx/sql
    @@ -87,7 +87,7 @@

    FORWARD

    FORWARD:
    @@ -97,7 +97,7 @@

    REVERSE

    REVERSE:
    @@ -107,7 +107,7 @@

    UNKNOWN

    UNKNOWN:
    diff --git a/docs/@vertx/sql-common/enums/resultsetconcurrency.html b/docs/@vertx/sql/enums/resultsetconcurrency.html similarity index 98% rename from docs/@vertx/sql-common/enums/resultsetconcurrency.html rename to docs/@vertx/sql/enums/resultsetconcurrency.html index 441cc07fa..bd2f64bbf 100644 --- a/docs/@vertx/sql-common/enums/resultsetconcurrency.html +++ b/docs/@vertx/sql/enums/resultsetconcurrency.html @@ -3,7 +3,7 @@ - ResultSetConcurrency | @vertx/sql-common + ResultSetConcurrency | @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -86,7 +86,7 @@

    READ_ONLY

    READ_ONLY:
    @@ -96,7 +96,7 @@

    UPDATABLE

    UPDATABLE:
    diff --git a/docs/@vertx/sql-common/enums/resultsettype.html b/docs/@vertx/sql/enums/resultsettype.html similarity index 97% rename from docs/@vertx/sql-common/enums/resultsettype.html rename to docs/@vertx/sql/enums/resultsettype.html index 66dba2adf..56dc8e9b3 100644 --- a/docs/@vertx/sql-common/enums/resultsettype.html +++ b/docs/@vertx/sql/enums/resultsettype.html @@ -3,7 +3,7 @@ - ResultSetType | @vertx/sql-common + ResultSetType | @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -87,7 +87,7 @@

    FORWARD_ONLY

    FORWARD_ONLY:
    @@ -97,7 +97,7 @@

    SCROLL_INSENSITIVE

    SCROLL_INSENSITIVE:
    @@ -107,7 +107,7 @@

    SCROLL_SENSITIVE

    SCROLL_SENSITIVE:
    diff --git a/docs/@vertx/sql-common/enums/transactionisolation.html b/docs/@vertx/sql/enums/transactionisolation.html similarity index 97% rename from docs/@vertx/sql-common/enums/transactionisolation.html rename to docs/@vertx/sql/enums/transactionisolation.html index e169439c1..36ecf5785 100644 --- a/docs/@vertx/sql-common/enums/transactionisolation.html +++ b/docs/@vertx/sql/enums/transactionisolation.html @@ -3,7 +3,7 @@ - TransactionIsolation | @vertx/sql-common + TransactionIsolation | @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -89,7 +89,7 @@

    NONE

    NONE:
    @@ -99,7 +99,7 @@

    READ_COMMITTED

    READ_COMMITTED:
    @@ -109,7 +109,7 @@

    READ_UNCOMMITTED

    READ_UNCOMMITTED:
    @@ -119,7 +119,7 @@

    REPEATABLE_READ

    REPEATABLE_READ:
    @@ -129,7 +129,7 @@

    SERIALIZABLE

    SERIALIZABLE:
    diff --git a/docs/@vertx/sql-common/globals.html b/docs/@vertx/sql/globals.html similarity index 98% rename from docs/@vertx/sql-common/globals.html rename to docs/@vertx/sql/globals.html index 203a25f90..e00d2a8c0 100644 --- a/docs/@vertx/sql-common/globals.html +++ b/docs/@vertx/sql/globals.html @@ -3,7 +3,7 @@ - @vertx/sql-common + @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -54,7 +54,7 @@ Globals -

    @vertx/sql-common

    +

    @vertx/sql

    diff --git a/docs/@vertx/sql-common/index.html b/docs/@vertx/sql/index.html similarity index 98% rename from docs/@vertx/sql-common/index.html rename to docs/@vertx/sql/index.html index 1bdc534be..e9b2be6ee 100644 --- a/docs/@vertx/sql-common/index.html +++ b/docs/@vertx/sql/index.html @@ -3,7 +3,7 @@ - @vertx/sql-common + @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -54,7 +54,7 @@ Globals -

    @vertx/sql-common

    +

    @vertx/sql

    diff --git a/docs/@vertx/sql-common/interfaces/sqloperations.html b/docs/@vertx/sql/interfaces/sqloperations.html similarity index 59% rename from docs/@vertx/sql-common/interfaces/sqloperations.html rename to docs/@vertx/sql/interfaces/sqloperations.html index f2f79a7a5..147110555 100644 --- a/docs/@vertx/sql-common/interfaces/sqloperations.html +++ b/docs/@vertx/sql/interfaces/sqloperations.html @@ -3,7 +3,7 @@ - SQLOperations | @vertx/sql-common + SQLOperations | @vertx/sql @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/sql-common + @vertx/sql
    @@ -72,6 +72,13 @@

    Hierarchy

    +
    +

    Implemented by

    + +

    Index

    @@ -84,6 +91,8 @@

    Methods

  • query
  • querySingle
  • querySingleWithParams
    • +
  • queryStream
    • +
  • queryStreamWithParams
  • queryWithParams
  • update
  • updateWithParams
    • @@ -104,12 +113,12 @@

    call

  • -

    Calls the given SQL PROCEDURE which returns the result from the procedure.

    +

    Calls the given SQL PROCEDURE which returns the result from the procedure.

    see
    @@ -133,17 +142,20 @@
    resultHandler: function

      • Parameters

        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<ResultSet>> +

      • @@ -164,12 +176,12 @@

      callWithParams

    • -

      Calls the given SQL PROCEDURE which returns the result from the procedure.

      +

      Calls the given SQL PROCEDURE which returns the result from the procedure.

      The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:

      @@ -211,17 +223,20 @@
      resultHandler: function

        • Parameters

          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<ResultSet>> +

        • @@ -242,12 +257,12 @@

        query

      • -

        Executes the given SQL SELECT statement which returns the results of the query.

        +

        Executes the given SQL SELECT statement which returns the results of the query.

        see
        @@ -274,17 +289,20 @@
        resultHandler: function

          • Parameters

            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<ResultSet>> +

          • @@ -305,12 +323,12 @@

          querySingle

        • -

          Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by +

          Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

          @@ -331,17 +349,20 @@
          handler: function
            • -
            • (result: AsyncResult<any[]>): void
              • +
            • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

            • Parameters

              • -
                result: AsyncResult<any[]>
                +
                res: AsyncResult<any[]>
              -

              Returns void

              +

              Returns void + | + Handler<AsyncResult<any[]>> +

            • @@ -363,12 +384,12 @@

            querySingleWithParams

          • -

            Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the +

            Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

            @@ -395,17 +416,20 @@
            handler: function
              • -
              • (result: AsyncResult<any[]>): void
                • +
              • (res: AsyncResult<any[]>): void | Handler<AsyncResult<any[]>>

              • Parameters

                • -
                  result: AsyncResult<any[]>
                  +
                  res: AsyncResult<any[]>
                -

                Returns void

                +

                Returns void + | + Handler<AsyncResult<any[]>> +

              • @@ -417,6 +441,144 @@

              Returns + +

              queryStream

              + +
                +
              • + +
                +
                +

                Executes the given SQL SELECT statement which returns the results of the query as a read stream.

                +
                +
                +
                see
                +

                java.sql.Statement#executeQuery(String)

                +
                +
                see
                +

                java.sql.PreparedStatement#executeQuery(String)

                +
                +
                +
                +

                Parameters

                +
                  +
                • +
                  sql: string
                  +
                  +

                  the SQL to execute. For example SELECT * FROM table ....

                  +
                  +
                  • +
                • +
                  handler: function
                  +
                  +

                  the handler which is called once the operation completes. It will return a {@code SQLRowStream}.

                  +
                  + +
                  • +
                +

                Returns SQLOperations

                +
                • +
              +
    • +
    + +

    queryStreamWithParams

    +
      +
    • queryStreamWithParams(sql: string, params: any[], handler: function): SQLOperations
      • +
    +
      +
    • + +
      +
      +

      Executes the given SQL SELECT statement which returns the results of the query as a read stream.

      +
      +
      +
      see
      +

      java.sql.Statement#executeQuery(String)

      +
      +
      see
      +

      java.sql.PreparedStatement#executeQuery(String)

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        sql: string
        +
        +

        the SQL to execute. For example SELECT * FROM table ....

        +
        +
        • +
      • +
        params: any[]
        +
        +

        these are the parameters to fill the statement.

        +
        +
        • +
      • +
        handler: function
        +
        +

        the handler which is called once the operation completes. It will return a {@code SQLRowStream}.

        +
        + +
        • +
      +

      Returns SQLOperations

      +
      • +
    +

    queryWithParams

    @@ -427,12 +589,12 @@

    queryWithParams

  • -

    Executes the given SQL SELECT prepared statement which returns the results of the query.

    +

    Executes the given SQL SELECT prepared statement which returns the results of the query.

    see
    @@ -465,17 +627,20 @@
    resultHandler: function

      • Parameters

        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<ResultSet>> +

      • @@ -496,12 +661,12 @@

      update

    • -

      Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE +

      Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

      @@ -529,17 +694,20 @@
      resultHandler: function
        • @@ -560,12 +728,12 @@

        updateWithParams

      • -

        Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE +

        Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

        @@ -599,17 +767,20 @@
        resultHandler: function
          • @@ -682,6 +853,12 @@

          Returns querySingleWithParams +
        • + queryStream +
          • +
        • + queryStreamWithParams +
        • queryWithParams
          • diff --git a/docs/@vertx/stomp/assets/js/search.js b/docs/@vertx/stomp/assets/js/search.js index 805834308..6eed7d049 100644 --- a/docs/@vertx/stomp/assets/js/search.js +++ b/docs/@vertx/stomp/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"BridgeOptions","url":"classes/bridgeoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"inboundPermitteds","url":"classes/bridgeoptions.html#inboundpermitteds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BridgeOptions"},{"id":2,"kind":1024,"name":"outboundPermitteds","url":"classes/bridgeoptions.html#outboundpermitteds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BridgeOptions"},{"id":3,"kind":1024,"name":"pointToPoint","url":"classes/bridgeoptions.html#pointtopoint","classes":"tsd-kind-property tsd-parent-kind-class","parent":"BridgeOptions"},{"id":4,"kind":128,"name":"Frame","url":"classes/frame.html","classes":"tsd-kind-class"},{"id":5,"kind":1024,"name":"body","url":"classes/frame.html#body","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Frame"},{"id":6,"kind":1024,"name":"command","url":"classes/frame.html#command","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Frame"},{"id":7,"kind":1024,"name":"destination","url":"classes/frame.html#destination","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Frame"},{"id":8,"kind":1024,"name":"headers","url":"classes/frame.html#headers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Frame"},{"id":9,"kind":1024,"name":"id","url":"classes/frame.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Frame"},{"id":10,"kind":1024,"name":"transaction","url":"classes/frame.html#transaction","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Frame"},{"id":11,"kind":128,"name":"StompClientOptions","url":"classes/stompclientoptions.html","classes":"tsd-kind-class"},{"id":12,"kind":1024,"name":"acceptedVersions","url":"classes/stompclientoptions.html#acceptedversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":13,"kind":1024,"name":"autoComputeContentLength","url":"classes/stompclientoptions.html#autocomputecontentlength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":14,"kind":1024,"name":"bypassHostHeader","url":"classes/stompclientoptions.html#bypasshostheader","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":15,"kind":1024,"name":"connectTimeout","url":"classes/stompclientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":16,"kind":1024,"name":"crlPaths","url":"classes/stompclientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":17,"kind":1024,"name":"crlValues","url":"classes/stompclientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":18,"kind":1024,"name":"enabledCipherSuites","url":"classes/stompclientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":19,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/stompclientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":20,"kind":1024,"name":"heartbeat","url":"classes/stompclientoptions.html#heartbeat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":21,"kind":1024,"name":"host","url":"classes/stompclientoptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":22,"kind":1024,"name":"hostnameVerificationAlgorithm","url":"classes/stompclientoptions.html#hostnameverificationalgorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":23,"kind":1024,"name":"idleTimeout","url":"classes/stompclientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":24,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/stompclientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":25,"kind":1024,"name":"keyStoreOptions","url":"classes/stompclientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":26,"kind":1024,"name":"localAddress","url":"classes/stompclientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":27,"kind":1024,"name":"logActivity","url":"classes/stompclientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":28,"kind":1024,"name":"login","url":"classes/stompclientoptions.html#login","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":29,"kind":1024,"name":"metricsName","url":"classes/stompclientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":30,"kind":1024,"name":"openSslEngineOptions","url":"classes/stompclientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":31,"kind":1024,"name":"passcode","url":"classes/stompclientoptions.html#passcode","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":32,"kind":1024,"name":"pemKeyCertOptions","url":"classes/stompclientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":33,"kind":1024,"name":"pemTrustOptions","url":"classes/stompclientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":34,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/stompclientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":35,"kind":1024,"name":"pfxTrustOptions","url":"classes/stompclientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":36,"kind":1024,"name":"port","url":"classes/stompclientoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":37,"kind":1024,"name":"proxyOptions","url":"classes/stompclientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":38,"kind":1024,"name":"receiveBufferSize","url":"classes/stompclientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":39,"kind":1024,"name":"reconnectAttempts","url":"classes/stompclientoptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":40,"kind":1024,"name":"reconnectInterval","url":"classes/stompclientoptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":41,"kind":1024,"name":"reuseAddress","url":"classes/stompclientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":42,"kind":1024,"name":"reusePort","url":"classes/stompclientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":43,"kind":1024,"name":"sendBufferSize","url":"classes/stompclientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":44,"kind":1024,"name":"soLinger","url":"classes/stompclientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":45,"kind":1024,"name":"ssl","url":"classes/stompclientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":46,"kind":1024,"name":"tcpCork","url":"classes/stompclientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":47,"kind":1024,"name":"tcpFastOpen","url":"classes/stompclientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":48,"kind":1024,"name":"tcpKeepAlive","url":"classes/stompclientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":49,"kind":1024,"name":"tcpNoDelay","url":"classes/stompclientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":50,"kind":1024,"name":"tcpQuickAck","url":"classes/stompclientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":51,"kind":1024,"name":"trafficClass","url":"classes/stompclientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":52,"kind":1024,"name":"trailingLine","url":"classes/stompclientoptions.html#trailingline","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":53,"kind":1024,"name":"trustAll","url":"classes/stompclientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":54,"kind":1024,"name":"trustStoreOptions","url":"classes/stompclientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":55,"kind":1024,"name":"useAlpn","url":"classes/stompclientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":56,"kind":1024,"name":"usePooledBuffers","url":"classes/stompclientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":57,"kind":1024,"name":"useStompFrame","url":"classes/stompclientoptions.html#usestompframe","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":58,"kind":1024,"name":"virtualHost","url":"classes/stompclientoptions.html#virtualhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompClientOptions"},{"id":59,"kind":128,"name":"StompServerOptions","url":"classes/stompserveroptions.html","classes":"tsd-kind-class"},{"id":60,"kind":1024,"name":"acceptBacklog","url":"classes/stompserveroptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":61,"kind":1024,"name":"clientAuth","url":"classes/stompserveroptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":62,"kind":1024,"name":"clientAuthRequired","url":"classes/stompserveroptions.html#clientauthrequired","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":63,"kind":1024,"name":"crlPaths","url":"classes/stompserveroptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":64,"kind":1024,"name":"crlValues","url":"classes/stompserveroptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":65,"kind":1024,"name":"enabledCipherSuites","url":"classes/stompserveroptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":66,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/stompserveroptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":67,"kind":1024,"name":"heartbeat","url":"classes/stompserveroptions.html#heartbeat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":68,"kind":1024,"name":"host","url":"classes/stompserveroptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":69,"kind":1024,"name":"idleTimeout","url":"classes/stompserveroptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":70,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/stompserveroptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":71,"kind":1024,"name":"keyStoreOptions","url":"classes/stompserveroptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":72,"kind":1024,"name":"logActivity","url":"classes/stompserveroptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":73,"kind":1024,"name":"maxBodyLength","url":"classes/stompserveroptions.html#maxbodylength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":74,"kind":1024,"name":"maxFrameInTransaction","url":"classes/stompserveroptions.html#maxframeintransaction","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":75,"kind":1024,"name":"maxHeaderLength","url":"classes/stompserveroptions.html#maxheaderlength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":76,"kind":1024,"name":"maxHeaders","url":"classes/stompserveroptions.html#maxheaders","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":77,"kind":1024,"name":"maxSubscriptionsByClient","url":"classes/stompserveroptions.html#maxsubscriptionsbyclient","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":78,"kind":1024,"name":"openSslEngineOptions","url":"classes/stompserveroptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":79,"kind":1024,"name":"pemKeyCertOptions","url":"classes/stompserveroptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":80,"kind":1024,"name":"pemTrustOptions","url":"classes/stompserveroptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":81,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/stompserveroptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":82,"kind":1024,"name":"pfxTrustOptions","url":"classes/stompserveroptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":83,"kind":1024,"name":"port","url":"classes/stompserveroptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":84,"kind":1024,"name":"receiveBufferSize","url":"classes/stompserveroptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":85,"kind":1024,"name":"reuseAddress","url":"classes/stompserveroptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":86,"kind":1024,"name":"reusePort","url":"classes/stompserveroptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":87,"kind":1024,"name":"secured","url":"classes/stompserveroptions.html#secured","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":88,"kind":1024,"name":"sendBufferSize","url":"classes/stompserveroptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":89,"kind":1024,"name":"sendErrorOnNoSubscriptions","url":"classes/stompserveroptions.html#senderroronnosubscriptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":90,"kind":1024,"name":"sni","url":"classes/stompserveroptions.html#sni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":91,"kind":1024,"name":"soLinger","url":"classes/stompserveroptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":92,"kind":1024,"name":"ssl","url":"classes/stompserveroptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":93,"kind":1024,"name":"supportedVersions","url":"classes/stompserveroptions.html#supportedversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":94,"kind":1024,"name":"tcpCork","url":"classes/stompserveroptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":95,"kind":1024,"name":"tcpFastOpen","url":"classes/stompserveroptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":96,"kind":1024,"name":"tcpKeepAlive","url":"classes/stompserveroptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":97,"kind":1024,"name":"tcpNoDelay","url":"classes/stompserveroptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":98,"kind":1024,"name":"tcpQuickAck","url":"classes/stompserveroptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":99,"kind":1024,"name":"timeFactor","url":"classes/stompserveroptions.html#timefactor","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":100,"kind":1024,"name":"trafficClass","url":"classes/stompserveroptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":101,"kind":1024,"name":"trailingLine","url":"classes/stompserveroptions.html#trailingline","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":102,"kind":1024,"name":"transactionChunkSize","url":"classes/stompserveroptions.html#transactionchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":103,"kind":1024,"name":"trustStoreOptions","url":"classes/stompserveroptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":104,"kind":1024,"name":"useAlpn","url":"classes/stompserveroptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":105,"kind":1024,"name":"usePooledBuffers","url":"classes/stompserveroptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":106,"kind":1024,"name":"websocketBridge","url":"classes/stompserveroptions.html#websocketbridge","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":107,"kind":1024,"name":"websocketPath","url":"classes/stompserveroptions.html#websocketpath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"StompServerOptions"},{"id":108,"kind":128,"name":"Acknowledgement","url":"classes/acknowledgement.html","classes":"tsd-kind-class"},{"id":109,"kind":2048,"name":"subscription","url":"classes/acknowledgement.html#subscription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Acknowledgement"},{"id":110,"kind":2048,"name":"frames","url":"classes/acknowledgement.html#frames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Acknowledgement"},{"id":111,"kind":128,"name":"Destination","url":"classes/destination.html","classes":"tsd-kind-class"},{"id":112,"kind":2048,"name":"topic","url":"classes/destination.html#topic","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Destination"},{"id":113,"kind":2048,"name":"queue","url":"classes/destination.html#queue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Destination"},{"id":114,"kind":2048,"name":"bridge","url":"classes/destination.html#bridge","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Destination"},{"id":115,"kind":2048,"name":"destination","url":"classes/destination.html#destination-1","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":116,"kind":2048,"name":"dispatch","url":"classes/destination.html#dispatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":117,"kind":2048,"name":"subscribe","url":"classes/destination.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":118,"kind":2048,"name":"unsubscribe","url":"classes/destination.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":119,"kind":2048,"name":"unsubscribeConnection","url":"classes/destination.html#unsubscribeconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":120,"kind":2048,"name":"ack","url":"classes/destination.html#ack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":121,"kind":2048,"name":"nack","url":"classes/destination.html#nack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":122,"kind":2048,"name":"getSubscriptions","url":"classes/destination.html#getsubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":123,"kind":2048,"name":"numberOfSubscriptions","url":"classes/destination.html#numberofsubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":124,"kind":2048,"name":"matches","url":"classes/destination.html#matches","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":125,"kind":128,"name":"DestinationFactory","url":"classes/destinationfactory.html","classes":"tsd-kind-class"},{"id":126,"kind":2048,"name":"create","url":"classes/destinationfactory.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DestinationFactory"},{"id":127,"kind":128,"name":"Frames","url":"classes/frames.html","classes":"tsd-kind-class"},{"id":128,"kind":2048,"name":"createErrorFrame","url":"classes/frames.html#createerrorframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":129,"kind":2048,"name":"createReceiptFrame","url":"classes/frames.html#createreceiptframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":130,"kind":2048,"name":"handleReceipt","url":"classes/frames.html#handlereceipt","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":131,"kind":2048,"name":"ping","url":"classes/frames.html#ping","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":132,"kind":128,"name":"ServerFrame","url":"classes/serverframe.html","classes":"tsd-kind-class"},{"id":133,"kind":2048,"name":"frame","url":"classes/serverframe.html#frame","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerFrame"},{"id":134,"kind":2048,"name":"connection","url":"classes/serverframe.html#connection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerFrame"},{"id":135,"kind":128,"name":"StompClient","url":"classes/stompclient.html","classes":"tsd-kind-class"},{"id":136,"kind":2048,"name":"create","url":"classes/stompclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StompClient"},{"id":137,"kind":2048,"name":"connect","url":"classes/stompclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":138,"kind":2048,"name":"receivedFrameHandler","url":"classes/stompclient.html#receivedframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":139,"kind":2048,"name":"writingFrameHandler","url":"classes/stompclient.html#writingframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":140,"kind":2048,"name":"errorFrameHandler","url":"classes/stompclient.html#errorframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":141,"kind":2048,"name":"exceptionHandler","url":"classes/stompclient.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":142,"kind":2048,"name":"close","url":"classes/stompclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":143,"kind":2048,"name":"options","url":"classes/stompclient.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":144,"kind":2048,"name":"vertx","url":"classes/stompclient.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":145,"kind":2048,"name":"isClosed","url":"classes/stompclient.html#isclosed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":146,"kind":128,"name":"StompClientConnection","url":"classes/stompclientconnection.html","classes":"tsd-kind-class"},{"id":147,"kind":2048,"name":"session","url":"classes/stompclientconnection.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":148,"kind":2048,"name":"version","url":"classes/stompclientconnection.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":149,"kind":2048,"name":"close","url":"classes/stompclientconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":150,"kind":2048,"name":"server","url":"classes/stompclientconnection.html#server","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":151,"kind":2048,"name":"send","url":"classes/stompclientconnection.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":152,"kind":2048,"name":"subscribe","url":"classes/stompclientconnection.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":153,"kind":2048,"name":"unsubscribe","url":"classes/stompclientconnection.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":154,"kind":2048,"name":"errorHandler","url":"classes/stompclientconnection.html#errorhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":155,"kind":2048,"name":"closeHandler","url":"classes/stompclientconnection.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":156,"kind":2048,"name":"connectionDroppedHandler","url":"classes/stompclientconnection.html#connectiondroppedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":157,"kind":2048,"name":"pingHandler","url":"classes/stompclientconnection.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":158,"kind":2048,"name":"beginTX","url":"classes/stompclientconnection.html#begintx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":159,"kind":2048,"name":"commit","url":"classes/stompclientconnection.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":160,"kind":2048,"name":"abort","url":"classes/stompclientconnection.html#abort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":161,"kind":2048,"name":"disconnect","url":"classes/stompclientconnection.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":162,"kind":2048,"name":"ack","url":"classes/stompclientconnection.html#ack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":163,"kind":2048,"name":"nack","url":"classes/stompclientconnection.html#nack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":164,"kind":2048,"name":"receivedFrameHandler","url":"classes/stompclientconnection.html#receivedframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":165,"kind":2048,"name":"writingFrameHandler","url":"classes/stompclientconnection.html#writingframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":166,"kind":2048,"name":"exceptionHandler","url":"classes/stompclientconnection.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":167,"kind":2048,"name":"isConnected","url":"classes/stompclientconnection.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":168,"kind":128,"name":"StompServer","url":"classes/stompserver.html","classes":"tsd-kind-class"},{"id":169,"kind":2048,"name":"create","url":"classes/stompserver.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StompServer"},{"id":170,"kind":2048,"name":"handler","url":"classes/stompserver.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":171,"kind":2048,"name":"listen","url":"classes/stompserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":172,"kind":2048,"name":"close","url":"classes/stompserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":173,"kind":2048,"name":"isListening","url":"classes/stompserver.html#islistening","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":174,"kind":2048,"name":"actualPort","url":"classes/stompserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":175,"kind":2048,"name":"options","url":"classes/stompserver.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":176,"kind":2048,"name":"vertx","url":"classes/stompserver.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":177,"kind":2048,"name":"stompHandler","url":"classes/stompserver.html#stomphandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":178,"kind":2048,"name":"webSocketHandler","url":"classes/stompserver.html#websockethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":179,"kind":2048,"name":"writingFrameHandler","url":"classes/stompserver.html#writingframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":180,"kind":128,"name":"StompServerConnection","url":"classes/stompserverconnection.html","classes":"tsd-kind-class"},{"id":181,"kind":2048,"name":"write","url":"classes/stompserverconnection.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":182,"kind":2048,"name":"server","url":"classes/stompserverconnection.html#server","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":183,"kind":2048,"name":"handler","url":"classes/stompserverconnection.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":184,"kind":2048,"name":"session","url":"classes/stompserverconnection.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":185,"kind":2048,"name":"close","url":"classes/stompserverconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":186,"kind":2048,"name":"ping","url":"classes/stompserverconnection.html#ping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":187,"kind":2048,"name":"onServerActivity","url":"classes/stompserverconnection.html#onserveractivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":188,"kind":2048,"name":"configureHeartbeat","url":"classes/stompserverconnection.html#configureheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":189,"kind":128,"name":"StompServerHandler","url":"classes/stompserverhandler.html","classes":"tsd-kind-class"},{"id":190,"kind":2048,"name":"handle","url":"classes/stompserverhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":191,"kind":2048,"name":"create","url":"classes/stompserverhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StompServerHandler"},{"id":192,"kind":2048,"name":"receivedFrameHandler","url":"classes/stompserverhandler.html#receivedframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":193,"kind":2048,"name":"connectHandler","url":"classes/stompserverhandler.html#connecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":194,"kind":2048,"name":"stompHandler","url":"classes/stompserverhandler.html#stomphandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":195,"kind":2048,"name":"subscribeHandler","url":"classes/stompserverhandler.html#subscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":196,"kind":2048,"name":"unsubscribeHandler","url":"classes/stompserverhandler.html#unsubscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":197,"kind":2048,"name":"sendHandler","url":"classes/stompserverhandler.html#sendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":198,"kind":2048,"name":"closeHandler","url":"classes/stompserverhandler.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":199,"kind":2048,"name":"onClose","url":"classes/stompserverhandler.html#onclose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":200,"kind":2048,"name":"commitHandler","url":"classes/stompserverhandler.html#commithandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":201,"kind":2048,"name":"abortHandler","url":"classes/stompserverhandler.html#aborthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":202,"kind":2048,"name":"beginHandler","url":"classes/stompserverhandler.html#beginhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":203,"kind":2048,"name":"disconnectHandler","url":"classes/stompserverhandler.html#disconnecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":204,"kind":2048,"name":"ackHandler","url":"classes/stompserverhandler.html#ackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":205,"kind":2048,"name":"nackHandler","url":"classes/stompserverhandler.html#nackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":206,"kind":2048,"name":"onAuthenticationRequest","url":"classes/stompserverhandler.html#onauthenticationrequest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":207,"kind":2048,"name":"getUserBySession","url":"classes/stompserverhandler.html#getuserbysession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":208,"kind":2048,"name":"authProvider","url":"classes/stompserverhandler.html#authprovider","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":209,"kind":2048,"name":"getDestinations","url":"classes/stompserverhandler.html#getdestinations","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":210,"kind":2048,"name":"getDestination","url":"classes/stompserverhandler.html#getdestination","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":211,"kind":2048,"name":"onAck","url":"classes/stompserverhandler.html#onack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":212,"kind":2048,"name":"onNack","url":"classes/stompserverhandler.html#onnack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":213,"kind":2048,"name":"onAckHandler","url":"classes/stompserverhandler.html#onackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":214,"kind":2048,"name":"onNackHandler","url":"classes/stompserverhandler.html#onnackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":215,"kind":2048,"name":"pingHandler","url":"classes/stompserverhandler.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":216,"kind":2048,"name":"getOrCreateDestination","url":"classes/stompserverhandler.html#getorcreatedestination","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":217,"kind":2048,"name":"destinationFactory","url":"classes/stompserverhandler.html#destinationfactory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":218,"kind":2048,"name":"bridge","url":"classes/stompserverhandler.html#bridge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"BridgeOptions","url":"classes/bridgeoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/bridgeoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"BridgeOptions"},{"id":2,"kind":2048,"name":"getInboundPermitteds","url":"classes/bridgeoptions.html#getinboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":3,"kind":2048,"name":"setInboundPermitteds","url":"classes/bridgeoptions.html#setinboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":4,"kind":2048,"name":"addInboundPermitted","url":"classes/bridgeoptions.html#addinboundpermitted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":5,"kind":2048,"name":"getOutboundPermitteds","url":"classes/bridgeoptions.html#getoutboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":6,"kind":2048,"name":"setOutboundPermitteds","url":"classes/bridgeoptions.html#setoutboundpermitteds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":7,"kind":2048,"name":"addOutboundPermitted","url":"classes/bridgeoptions.html#addoutboundpermitted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":8,"kind":2048,"name":"isPointToPoint","url":"classes/bridgeoptions.html#ispointtopoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":9,"kind":2048,"name":"setPointToPoint","url":"classes/bridgeoptions.html#setpointtopoint","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeOptions"},{"id":10,"kind":128,"name":"Frame","url":"classes/frame.html","classes":"tsd-kind-class"},{"id":11,"kind":512,"name":"constructor","url":"classes/frame.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Frame"},{"id":12,"kind":2048,"name":"getAck","url":"classes/frame.html#getack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":13,"kind":2048,"name":"getBody","url":"classes/frame.html#getbody","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":14,"kind":2048,"name":"setBody","url":"classes/frame.html#setbody","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":15,"kind":2048,"name":"getBodyAsString","url":"classes/frame.html#getbodyasstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":16,"kind":2048,"name":"getCommand","url":"classes/frame.html#getcommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":17,"kind":2048,"name":"setCommand","url":"classes/frame.html#setcommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":18,"kind":2048,"name":"getDestination","url":"classes/frame.html#getdestination","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":19,"kind":2048,"name":"setDestination","url":"classes/frame.html#setdestination","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":20,"kind":2048,"name":"getHeaders","url":"classes/frame.html#getheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":21,"kind":2048,"name":"setHeaders","url":"classes/frame.html#setheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":22,"kind":2048,"name":"addHeader","url":"classes/frame.html#addheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":23,"kind":2048,"name":"getId","url":"classes/frame.html#getid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":24,"kind":2048,"name":"setId","url":"classes/frame.html#setid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":25,"kind":2048,"name":"getReceipt","url":"classes/frame.html#getreceipt","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":26,"kind":2048,"name":"getTransaction","url":"classes/frame.html#gettransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":27,"kind":2048,"name":"setTransaction","url":"classes/frame.html#settransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Frame"},{"id":28,"kind":128,"name":"StompClientOptions","url":"classes/stompclientoptions.html","classes":"tsd-kind-class"},{"id":29,"kind":512,"name":"constructor","url":"classes/stompclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"StompClientOptions"},{"id":30,"kind":2048,"name":"getAcceptedVersions","url":"classes/stompclientoptions.html#getacceptedversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":31,"kind":2048,"name":"setAcceptedVersions","url":"classes/stompclientoptions.html#setacceptedversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":32,"kind":2048,"name":"isAutoComputeContentLength","url":"classes/stompclientoptions.html#isautocomputecontentlength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":33,"kind":2048,"name":"setAutoComputeContentLength","url":"classes/stompclientoptions.html#setautocomputecontentlength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":34,"kind":2048,"name":"isBypassHostHeader","url":"classes/stompclientoptions.html#isbypasshostheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":35,"kind":2048,"name":"setBypassHostHeader","url":"classes/stompclientoptions.html#setbypasshostheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":36,"kind":2048,"name":"getConnectTimeout","url":"classes/stompclientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":37,"kind":2048,"name":"setConnectTimeout","url":"classes/stompclientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":38,"kind":2048,"name":"getCrlPaths","url":"classes/stompclientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":39,"kind":2048,"name":"addCrlPath","url":"classes/stompclientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":40,"kind":2048,"name":"getCrlValues","url":"classes/stompclientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":41,"kind":2048,"name":"addCrlValue","url":"classes/stompclientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":42,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/stompclientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":43,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/stompclientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":44,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/stompclientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":45,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/stompclientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":46,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/stompclientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":47,"kind":2048,"name":"getHeartbeat","url":"classes/stompclientoptions.html#getheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":48,"kind":2048,"name":"setHeartbeat","url":"classes/stompclientoptions.html#setheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":49,"kind":2048,"name":"getHost","url":"classes/stompclientoptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":50,"kind":2048,"name":"setHost","url":"classes/stompclientoptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":51,"kind":2048,"name":"getHostnameVerificationAlgorithm","url":"classes/stompclientoptions.html#gethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":52,"kind":2048,"name":"setHostnameVerificationAlgorithm","url":"classes/stompclientoptions.html#sethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":53,"kind":2048,"name":"getIdleTimeout","url":"classes/stompclientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":54,"kind":2048,"name":"setIdleTimeout","url":"classes/stompclientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":55,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/stompclientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":56,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/stompclientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":57,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/stompclientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":58,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/stompclientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":59,"kind":2048,"name":"getKeyStoreOptions","url":"classes/stompclientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":60,"kind":2048,"name":"setKeyStoreOptions","url":"classes/stompclientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":61,"kind":2048,"name":"getLocalAddress","url":"classes/stompclientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":62,"kind":2048,"name":"setLocalAddress","url":"classes/stompclientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":63,"kind":2048,"name":"getLogActivity","url":"classes/stompclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":64,"kind":2048,"name":"setLogActivity","url":"classes/stompclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":65,"kind":2048,"name":"getLogin","url":"classes/stompclientoptions.html#getlogin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":66,"kind":2048,"name":"setLogin","url":"classes/stompclientoptions.html#setlogin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":67,"kind":2048,"name":"getMetricsName","url":"classes/stompclientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":68,"kind":2048,"name":"setMetricsName","url":"classes/stompclientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":69,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/stompclientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":70,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/stompclientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":71,"kind":2048,"name":"getPasscode","url":"classes/stompclientoptions.html#getpasscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":72,"kind":2048,"name":"setPasscode","url":"classes/stompclientoptions.html#setpasscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":73,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/stompclientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":74,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/stompclientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":75,"kind":2048,"name":"getPemTrustOptions","url":"classes/stompclientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":76,"kind":2048,"name":"setPemTrustOptions","url":"classes/stompclientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":77,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/stompclientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":78,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/stompclientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":79,"kind":2048,"name":"getPfxTrustOptions","url":"classes/stompclientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":80,"kind":2048,"name":"setPfxTrustOptions","url":"classes/stompclientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":81,"kind":2048,"name":"getPort","url":"classes/stompclientoptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":82,"kind":2048,"name":"setPort","url":"classes/stompclientoptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":83,"kind":2048,"name":"getProxyOptions","url":"classes/stompclientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":84,"kind":2048,"name":"setProxyOptions","url":"classes/stompclientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":85,"kind":2048,"name":"getReceiveBufferSize","url":"classes/stompclientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":86,"kind":2048,"name":"setReceiveBufferSize","url":"classes/stompclientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":87,"kind":2048,"name":"getReconnectAttempts","url":"classes/stompclientoptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":88,"kind":2048,"name":"setReconnectAttempts","url":"classes/stompclientoptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":89,"kind":2048,"name":"getReconnectInterval","url":"classes/stompclientoptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":90,"kind":2048,"name":"setReconnectInterval","url":"classes/stompclientoptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":91,"kind":2048,"name":"isReuseAddress","url":"classes/stompclientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":92,"kind":2048,"name":"setReuseAddress","url":"classes/stompclientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":93,"kind":2048,"name":"isReusePort","url":"classes/stompclientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":94,"kind":2048,"name":"setReusePort","url":"classes/stompclientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":95,"kind":2048,"name":"getSendBufferSize","url":"classes/stompclientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":96,"kind":2048,"name":"setSendBufferSize","url":"classes/stompclientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":97,"kind":2048,"name":"getSoLinger","url":"classes/stompclientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":98,"kind":2048,"name":"setSoLinger","url":"classes/stompclientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":99,"kind":2048,"name":"isSsl","url":"classes/stompclientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":100,"kind":2048,"name":"setSsl","url":"classes/stompclientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":101,"kind":2048,"name":"isTcpCork","url":"classes/stompclientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":102,"kind":2048,"name":"setTcpCork","url":"classes/stompclientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":103,"kind":2048,"name":"isTcpFastOpen","url":"classes/stompclientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":104,"kind":2048,"name":"setTcpFastOpen","url":"classes/stompclientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":105,"kind":2048,"name":"isTcpKeepAlive","url":"classes/stompclientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":106,"kind":2048,"name":"setTcpKeepAlive","url":"classes/stompclientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":107,"kind":2048,"name":"isTcpNoDelay","url":"classes/stompclientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":108,"kind":2048,"name":"setTcpNoDelay","url":"classes/stompclientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":109,"kind":2048,"name":"isTcpQuickAck","url":"classes/stompclientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":110,"kind":2048,"name":"setTcpQuickAck","url":"classes/stompclientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":111,"kind":2048,"name":"getTrafficClass","url":"classes/stompclientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":112,"kind":2048,"name":"setTrafficClass","url":"classes/stompclientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":113,"kind":2048,"name":"isTrailingLine","url":"classes/stompclientoptions.html#istrailingline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":114,"kind":2048,"name":"setTrailingLine","url":"classes/stompclientoptions.html#settrailingline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":115,"kind":2048,"name":"isTrustAll","url":"classes/stompclientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":116,"kind":2048,"name":"setTrustAll","url":"classes/stompclientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":117,"kind":2048,"name":"getTrustStoreOptions","url":"classes/stompclientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":118,"kind":2048,"name":"setTrustStoreOptions","url":"classes/stompclientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":119,"kind":2048,"name":"isUseAlpn","url":"classes/stompclientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":120,"kind":2048,"name":"setUseAlpn","url":"classes/stompclientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":121,"kind":2048,"name":"isUsePooledBuffers","url":"classes/stompclientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":122,"kind":2048,"name":"setUsePooledBuffers","url":"classes/stompclientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":123,"kind":2048,"name":"isUseStompFrame","url":"classes/stompclientoptions.html#isusestompframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":124,"kind":2048,"name":"setUseStompFrame","url":"classes/stompclientoptions.html#setusestompframe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":125,"kind":2048,"name":"getVirtualHost","url":"classes/stompclientoptions.html#getvirtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":126,"kind":2048,"name":"setVirtualHost","url":"classes/stompclientoptions.html#setvirtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientOptions"},{"id":127,"kind":128,"name":"StompServerOptions","url":"classes/stompserveroptions.html","classes":"tsd-kind-class"},{"id":128,"kind":512,"name":"constructor","url":"classes/stompserveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"StompServerOptions"},{"id":129,"kind":2048,"name":"getAcceptBacklog","url":"classes/stompserveroptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":130,"kind":2048,"name":"setAcceptBacklog","url":"classes/stompserveroptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":131,"kind":2048,"name":"getClientAuth","url":"classes/stompserveroptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":132,"kind":2048,"name":"setClientAuth","url":"classes/stompserveroptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":133,"kind":2048,"name":"isClientAuthRequired","url":"classes/stompserveroptions.html#isclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":134,"kind":2048,"name":"setClientAuthRequired","url":"classes/stompserveroptions.html#setclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":135,"kind":2048,"name":"getCrlPaths","url":"classes/stompserveroptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":136,"kind":2048,"name":"addCrlPath","url":"classes/stompserveroptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":137,"kind":2048,"name":"getCrlValues","url":"classes/stompserveroptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":138,"kind":2048,"name":"addCrlValue","url":"classes/stompserveroptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":139,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/stompserveroptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":140,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/stompserveroptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":141,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/stompserveroptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":142,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/stompserveroptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":143,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/stompserveroptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":144,"kind":2048,"name":"getHeartbeat","url":"classes/stompserveroptions.html#getheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":145,"kind":2048,"name":"setHeartbeat","url":"classes/stompserveroptions.html#setheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":146,"kind":2048,"name":"getHost","url":"classes/stompserveroptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":147,"kind":2048,"name":"setHost","url":"classes/stompserveroptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":148,"kind":2048,"name":"getIdleTimeout","url":"classes/stompserveroptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":149,"kind":2048,"name":"setIdleTimeout","url":"classes/stompserveroptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":150,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/stompserveroptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":151,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/stompserveroptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":152,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/stompserveroptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":153,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/stompserveroptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":154,"kind":2048,"name":"getKeyStoreOptions","url":"classes/stompserveroptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":155,"kind":2048,"name":"setKeyStoreOptions","url":"classes/stompserveroptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":156,"kind":2048,"name":"getLogActivity","url":"classes/stompserveroptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":157,"kind":2048,"name":"setLogActivity","url":"classes/stompserveroptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":158,"kind":2048,"name":"getMaxBodyLength","url":"classes/stompserveroptions.html#getmaxbodylength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":159,"kind":2048,"name":"setMaxBodyLength","url":"classes/stompserveroptions.html#setmaxbodylength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":160,"kind":2048,"name":"getMaxFrameInTransaction","url":"classes/stompserveroptions.html#getmaxframeintransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":161,"kind":2048,"name":"setMaxFrameInTransaction","url":"classes/stompserveroptions.html#setmaxframeintransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":162,"kind":2048,"name":"getMaxHeaderLength","url":"classes/stompserveroptions.html#getmaxheaderlength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":163,"kind":2048,"name":"setMaxHeaderLength","url":"classes/stompserveroptions.html#setmaxheaderlength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":164,"kind":2048,"name":"getMaxHeaders","url":"classes/stompserveroptions.html#getmaxheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":165,"kind":2048,"name":"setMaxHeaders","url":"classes/stompserveroptions.html#setmaxheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":166,"kind":2048,"name":"getMaxSubscriptionsByClient","url":"classes/stompserveroptions.html#getmaxsubscriptionsbyclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":167,"kind":2048,"name":"setMaxSubscriptionsByClient","url":"classes/stompserveroptions.html#setmaxsubscriptionsbyclient","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":168,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/stompserveroptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":169,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/stompserveroptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":170,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/stompserveroptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":171,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/stompserveroptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":172,"kind":2048,"name":"getPemTrustOptions","url":"classes/stompserveroptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":173,"kind":2048,"name":"setPemTrustOptions","url":"classes/stompserveroptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":174,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/stompserveroptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":175,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/stompserveroptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":176,"kind":2048,"name":"getPfxTrustOptions","url":"classes/stompserveroptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":177,"kind":2048,"name":"setPfxTrustOptions","url":"classes/stompserveroptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":178,"kind":2048,"name":"getPort","url":"classes/stompserveroptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":179,"kind":2048,"name":"setPort","url":"classes/stompserveroptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":180,"kind":2048,"name":"getReceiveBufferSize","url":"classes/stompserveroptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":181,"kind":2048,"name":"setReceiveBufferSize","url":"classes/stompserveroptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":182,"kind":2048,"name":"isReuseAddress","url":"classes/stompserveroptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":183,"kind":2048,"name":"setReuseAddress","url":"classes/stompserveroptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":184,"kind":2048,"name":"isReusePort","url":"classes/stompserveroptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":185,"kind":2048,"name":"setReusePort","url":"classes/stompserveroptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":186,"kind":2048,"name":"isSecured","url":"classes/stompserveroptions.html#issecured","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":187,"kind":2048,"name":"setSecured","url":"classes/stompserveroptions.html#setsecured","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":188,"kind":2048,"name":"getSendBufferSize","url":"classes/stompserveroptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":189,"kind":2048,"name":"setSendBufferSize","url":"classes/stompserveroptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":190,"kind":2048,"name":"isSendErrorOnNoSubscriptions","url":"classes/stompserveroptions.html#issenderroronnosubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":191,"kind":2048,"name":"setSendErrorOnNoSubscriptions","url":"classes/stompserveroptions.html#setsenderroronnosubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":192,"kind":2048,"name":"isSni","url":"classes/stompserveroptions.html#issni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":193,"kind":2048,"name":"setSni","url":"classes/stompserveroptions.html#setsni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":194,"kind":2048,"name":"getSoLinger","url":"classes/stompserveroptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":195,"kind":2048,"name":"setSoLinger","url":"classes/stompserveroptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":196,"kind":2048,"name":"isSsl","url":"classes/stompserveroptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":197,"kind":2048,"name":"setSsl","url":"classes/stompserveroptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":198,"kind":2048,"name":"getSupportedVersions","url":"classes/stompserveroptions.html#getsupportedversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":199,"kind":2048,"name":"setSupportedVersions","url":"classes/stompserveroptions.html#setsupportedversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":200,"kind":2048,"name":"isTcpCork","url":"classes/stompserveroptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":201,"kind":2048,"name":"setTcpCork","url":"classes/stompserveroptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":202,"kind":2048,"name":"isTcpFastOpen","url":"classes/stompserveroptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":203,"kind":2048,"name":"setTcpFastOpen","url":"classes/stompserveroptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":204,"kind":2048,"name":"isTcpKeepAlive","url":"classes/stompserveroptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":205,"kind":2048,"name":"setTcpKeepAlive","url":"classes/stompserveroptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":206,"kind":2048,"name":"isTcpNoDelay","url":"classes/stompserveroptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":207,"kind":2048,"name":"setTcpNoDelay","url":"classes/stompserveroptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":208,"kind":2048,"name":"isTcpQuickAck","url":"classes/stompserveroptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":209,"kind":2048,"name":"setTcpQuickAck","url":"classes/stompserveroptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":210,"kind":2048,"name":"getTimeFactor","url":"classes/stompserveroptions.html#gettimefactor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":211,"kind":2048,"name":"setTimeFactor","url":"classes/stompserveroptions.html#settimefactor","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":212,"kind":2048,"name":"getTrafficClass","url":"classes/stompserveroptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":213,"kind":2048,"name":"setTrafficClass","url":"classes/stompserveroptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":214,"kind":2048,"name":"isTrailingLine","url":"classes/stompserveroptions.html#istrailingline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":215,"kind":2048,"name":"setTrailingLine","url":"classes/stompserveroptions.html#settrailingline","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":216,"kind":2048,"name":"getTransactionChunkSize","url":"classes/stompserveroptions.html#gettransactionchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":217,"kind":2048,"name":"setTransactionChunkSize","url":"classes/stompserveroptions.html#settransactionchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":218,"kind":2048,"name":"getTrustStoreOptions","url":"classes/stompserveroptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":219,"kind":2048,"name":"setTrustStoreOptions","url":"classes/stompserveroptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":220,"kind":2048,"name":"isUseAlpn","url":"classes/stompserveroptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":221,"kind":2048,"name":"setUseAlpn","url":"classes/stompserveroptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":222,"kind":2048,"name":"isUsePooledBuffers","url":"classes/stompserveroptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":223,"kind":2048,"name":"setUsePooledBuffers","url":"classes/stompserveroptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":224,"kind":2048,"name":"isWebsocketBridge","url":"classes/stompserveroptions.html#iswebsocketbridge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":225,"kind":2048,"name":"setWebsocketBridge","url":"classes/stompserveroptions.html#setwebsocketbridge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":226,"kind":2048,"name":"getWebsocketPath","url":"classes/stompserveroptions.html#getwebsocketpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":227,"kind":2048,"name":"setWebsocketPath","url":"classes/stompserveroptions.html#setwebsocketpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerOptions"},{"id":228,"kind":128,"name":"Acknowledgement","url":"classes/acknowledgement.html","classes":"tsd-kind-class"},{"id":229,"kind":2048,"name":"subscription","url":"classes/acknowledgement.html#subscription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Acknowledgement"},{"id":230,"kind":2048,"name":"frames","url":"classes/acknowledgement.html#frames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Acknowledgement"},{"id":231,"kind":128,"name":"Destination","url":"classes/destination.html","classes":"tsd-kind-class"},{"id":232,"kind":2048,"name":"topic","url":"classes/destination.html#topic","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Destination"},{"id":233,"kind":2048,"name":"queue","url":"classes/destination.html#queue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Destination"},{"id":234,"kind":2048,"name":"bridge","url":"classes/destination.html#bridge","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Destination"},{"id":235,"kind":2048,"name":"destination","url":"classes/destination.html#destination-1","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":236,"kind":2048,"name":"dispatch","url":"classes/destination.html#dispatch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":237,"kind":2048,"name":"subscribe","url":"classes/destination.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":238,"kind":2048,"name":"unsubscribe","url":"classes/destination.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":239,"kind":2048,"name":"unsubscribeConnection","url":"classes/destination.html#unsubscribeconnection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":240,"kind":2048,"name":"ack","url":"classes/destination.html#ack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":241,"kind":2048,"name":"nack","url":"classes/destination.html#nack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":242,"kind":2048,"name":"getSubscriptions","url":"classes/destination.html#getsubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":243,"kind":2048,"name":"numberOfSubscriptions","url":"classes/destination.html#numberofsubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":244,"kind":2048,"name":"matches","url":"classes/destination.html#matches","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Destination"},{"id":245,"kind":128,"name":"DestinationFactory","url":"classes/destinationfactory.html","classes":"tsd-kind-class"},{"id":246,"kind":2048,"name":"create","url":"classes/destinationfactory.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"DestinationFactory"},{"id":247,"kind":128,"name":"Frames","url":"classes/frames.html","classes":"tsd-kind-class"},{"id":248,"kind":2048,"name":"createErrorFrame","url":"classes/frames.html#createerrorframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":249,"kind":2048,"name":"createReceiptFrame","url":"classes/frames.html#createreceiptframe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":250,"kind":2048,"name":"handleReceipt","url":"classes/frames.html#handlereceipt","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":251,"kind":2048,"name":"ping","url":"classes/frames.html#ping","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Frames"},{"id":252,"kind":128,"name":"ServerFrame","url":"classes/serverframe.html","classes":"tsd-kind-class"},{"id":253,"kind":2048,"name":"frame","url":"classes/serverframe.html#frame","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerFrame"},{"id":254,"kind":2048,"name":"connection","url":"classes/serverframe.html#connection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ServerFrame"},{"id":255,"kind":128,"name":"StompClient","url":"classes/stompclient.html","classes":"tsd-kind-class"},{"id":256,"kind":2048,"name":"create","url":"classes/stompclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StompClient"},{"id":257,"kind":2048,"name":"connect","url":"classes/stompclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":258,"kind":2048,"name":"receivedFrameHandler","url":"classes/stompclient.html#receivedframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":259,"kind":2048,"name":"writingFrameHandler","url":"classes/stompclient.html#writingframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":260,"kind":2048,"name":"errorFrameHandler","url":"classes/stompclient.html#errorframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":261,"kind":2048,"name":"exceptionHandler","url":"classes/stompclient.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":262,"kind":2048,"name":"close","url":"classes/stompclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":263,"kind":2048,"name":"options","url":"classes/stompclient.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":264,"kind":2048,"name":"vertx","url":"classes/stompclient.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":265,"kind":2048,"name":"isClosed","url":"classes/stompclient.html#isclosed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClient"},{"id":266,"kind":128,"name":"StompClientConnection","url":"classes/stompclientconnection.html","classes":"tsd-kind-class"},{"id":267,"kind":2048,"name":"session","url":"classes/stompclientconnection.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":268,"kind":2048,"name":"version","url":"classes/stompclientconnection.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":269,"kind":2048,"name":"close","url":"classes/stompclientconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":270,"kind":2048,"name":"server","url":"classes/stompclientconnection.html#server","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":271,"kind":2048,"name":"send","url":"classes/stompclientconnection.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":272,"kind":2048,"name":"subscribe","url":"classes/stompclientconnection.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":273,"kind":2048,"name":"unsubscribe","url":"classes/stompclientconnection.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":274,"kind":2048,"name":"errorHandler","url":"classes/stompclientconnection.html#errorhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":275,"kind":2048,"name":"closeHandler","url":"classes/stompclientconnection.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":276,"kind":2048,"name":"connectionDroppedHandler","url":"classes/stompclientconnection.html#connectiondroppedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":277,"kind":2048,"name":"pingHandler","url":"classes/stompclientconnection.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":278,"kind":2048,"name":"beginTX","url":"classes/stompclientconnection.html#begintx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":279,"kind":2048,"name":"commit","url":"classes/stompclientconnection.html#commit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":280,"kind":2048,"name":"abort","url":"classes/stompclientconnection.html#abort","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":281,"kind":2048,"name":"disconnect","url":"classes/stompclientconnection.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":282,"kind":2048,"name":"ack","url":"classes/stompclientconnection.html#ack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":283,"kind":2048,"name":"nack","url":"classes/stompclientconnection.html#nack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":284,"kind":2048,"name":"receivedFrameHandler","url":"classes/stompclientconnection.html#receivedframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":285,"kind":2048,"name":"writingFrameHandler","url":"classes/stompclientconnection.html#writingframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":286,"kind":2048,"name":"exceptionHandler","url":"classes/stompclientconnection.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":287,"kind":2048,"name":"isConnected","url":"classes/stompclientconnection.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompClientConnection"},{"id":288,"kind":128,"name":"StompServer","url":"classes/stompserver.html","classes":"tsd-kind-class"},{"id":289,"kind":2048,"name":"create","url":"classes/stompserver.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StompServer"},{"id":290,"kind":2048,"name":"handler","url":"classes/stompserver.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":291,"kind":2048,"name":"listen","url":"classes/stompserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":292,"kind":2048,"name":"close","url":"classes/stompserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":293,"kind":2048,"name":"isListening","url":"classes/stompserver.html#islistening","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":294,"kind":2048,"name":"actualPort","url":"classes/stompserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":295,"kind":2048,"name":"options","url":"classes/stompserver.html#options","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":296,"kind":2048,"name":"vertx","url":"classes/stompserver.html#vertx","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":297,"kind":2048,"name":"stompHandler","url":"classes/stompserver.html#stomphandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":298,"kind":2048,"name":"webSocketHandler","url":"classes/stompserver.html#websockethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":299,"kind":2048,"name":"writingFrameHandler","url":"classes/stompserver.html#writingframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServer"},{"id":300,"kind":128,"name":"StompServerConnection","url":"classes/stompserverconnection.html","classes":"tsd-kind-class"},{"id":301,"kind":2048,"name":"write","url":"classes/stompserverconnection.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":302,"kind":2048,"name":"server","url":"classes/stompserverconnection.html#server","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":303,"kind":2048,"name":"handler","url":"classes/stompserverconnection.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":304,"kind":2048,"name":"session","url":"classes/stompserverconnection.html#session","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":305,"kind":2048,"name":"close","url":"classes/stompserverconnection.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":306,"kind":2048,"name":"ping","url":"classes/stompserverconnection.html#ping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":307,"kind":2048,"name":"onServerActivity","url":"classes/stompserverconnection.html#onserveractivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":308,"kind":2048,"name":"configureHeartbeat","url":"classes/stompserverconnection.html#configureheartbeat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerConnection"},{"id":309,"kind":128,"name":"StompServerHandler","url":"classes/stompserverhandler.html","classes":"tsd-kind-class"},{"id":310,"kind":2048,"name":"handle","url":"classes/stompserverhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":311,"kind":2048,"name":"create","url":"classes/stompserverhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"StompServerHandler"},{"id":312,"kind":2048,"name":"receivedFrameHandler","url":"classes/stompserverhandler.html#receivedframehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":313,"kind":2048,"name":"connectHandler","url":"classes/stompserverhandler.html#connecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":314,"kind":2048,"name":"stompHandler","url":"classes/stompserverhandler.html#stomphandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":315,"kind":2048,"name":"subscribeHandler","url":"classes/stompserverhandler.html#subscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":316,"kind":2048,"name":"unsubscribeHandler","url":"classes/stompserverhandler.html#unsubscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":317,"kind":2048,"name":"sendHandler","url":"classes/stompserverhandler.html#sendhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":318,"kind":2048,"name":"closeHandler","url":"classes/stompserverhandler.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":319,"kind":2048,"name":"onClose","url":"classes/stompserverhandler.html#onclose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":320,"kind":2048,"name":"commitHandler","url":"classes/stompserverhandler.html#commithandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":321,"kind":2048,"name":"abortHandler","url":"classes/stompserverhandler.html#aborthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":322,"kind":2048,"name":"beginHandler","url":"classes/stompserverhandler.html#beginhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":323,"kind":2048,"name":"disconnectHandler","url":"classes/stompserverhandler.html#disconnecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":324,"kind":2048,"name":"ackHandler","url":"classes/stompserverhandler.html#ackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":325,"kind":2048,"name":"nackHandler","url":"classes/stompserverhandler.html#nackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":326,"kind":2048,"name":"onAuthenticationRequest","url":"classes/stompserverhandler.html#onauthenticationrequest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":327,"kind":2048,"name":"getUserBySession","url":"classes/stompserverhandler.html#getuserbysession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":328,"kind":2048,"name":"authProvider","url":"classes/stompserverhandler.html#authprovider","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":329,"kind":2048,"name":"getDestinations","url":"classes/stompserverhandler.html#getdestinations","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":330,"kind":2048,"name":"getDestination","url":"classes/stompserverhandler.html#getdestination","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":331,"kind":2048,"name":"onAck","url":"classes/stompserverhandler.html#onack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":332,"kind":2048,"name":"onNack","url":"classes/stompserverhandler.html#onnack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":333,"kind":2048,"name":"onAckHandler","url":"classes/stompserverhandler.html#onackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":334,"kind":2048,"name":"onNackHandler","url":"classes/stompserverhandler.html#onnackhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":335,"kind":2048,"name":"pingHandler","url":"classes/stompserverhandler.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":336,"kind":2048,"name":"getOrCreateDestination","url":"classes/stompserverhandler.html#getorcreatedestination","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":337,"kind":2048,"name":"destinationFactory","url":"classes/stompserverhandler.html#destinationfactory","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"},{"id":338,"kind":2048,"name":"bridge","url":"classes/stompserverhandler.html#bridge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"StompServerHandler"}]}; \ No newline at end of file diff --git a/docs/@vertx/stomp/classes/acknowledgement.html b/docs/@vertx/stomp/classes/acknowledgement.html index 85cfcd998..b3a8ad69f 100644 --- a/docs/@vertx/stomp/classes/acknowledgement.html +++ b/docs/@vertx/stomp/classes/acknowledgement.html @@ -98,7 +98,7 @@

          frames

        • @@ -119,7 +119,7 @@

          subscription

        • diff --git a/docs/@vertx/stomp/classes/bridgeoptions.html b/docs/@vertx/stomp/classes/bridgeoptions.html index 45283611b..7c451d766 100644 --- a/docs/@vertx/stomp/classes/bridgeoptions.html +++ b/docs/@vertx/stomp/classes/bridgeoptions.html @@ -77,47 +77,229 @@

          Index

          -

          Properties

          +

          Constructors

          +
          +
          +

          Methods

          +
    • -

    Properties

    -
    - -

    inboundPermitteds

    -
    inboundPermitteds: PermittedOptions
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    outboundPermitteds

    -
    outboundPermitteds: PermittedOptions
    - +
    +
    +

    Methods

    +
    + +

    addInboundPermitted

    +
      +
    • addInboundPermitted(inboundPermitteds: PermittedOptions): BridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        inboundPermitteds: PermittedOptions
        +
        • +
      +

      Returns BridgeOptions

      +
      • +
    -
    - -

    pointToPoint

    -
    pointToPoint: boolean
    - +
    + +

    addOutboundPermitted

    +
      +
    • addOutboundPermitted(outboundPermitteds: PermittedOptions): BridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        outboundPermitteds: PermittedOptions
        +
        • +
      +

      Returns BridgeOptions

      +
      • +
    +
    +
    + +

    getInboundPermitteds

    +
      +
    • getInboundPermitteds(): PermittedOptions
      • +
    +
      +
    • + +

      Returns PermittedOptions

      +
      • +
    +
    +
    + +

    getOutboundPermitteds

    +
      +
    • getOutboundPermitteds(): PermittedOptions
      • +
    +
      +
    • + +

      Returns PermittedOptions

      +
      • +
    +
    +
    + +

    isPointToPoint

    +
      +
    • isPointToPoint(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setInboundPermitteds

    +
      +
    • setInboundPermitteds(inboundPermitteds: PermittedOptions): BridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        inboundPermitteds: PermittedOptions
        +
        • +
      +

      Returns BridgeOptions

      +
      • +
    +
    +
    + +

    setOutboundPermitteds

    +
      +
    • setOutboundPermitteds(outboundPermitteds: PermittedOptions): BridgeOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        outboundPermitteds: PermittedOptions
        +
        • +
      +

      Returns BridgeOptions

      +
      • +
    +
    +
    + +

    setPointToPoint

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pointToPoint: boolean
        +
        • +
      +

      Returns BridgeOptions

      +
      • +
    @@ -139,14 +321,32 @@

    pointToPoint

  • BridgeOptions
    • diff --git a/docs/@vertx/stomp/classes/destination.html b/docs/@vertx/stomp/classes/destination.html index e8bc5d0a7..ef0de004c 100644 --- a/docs/@vertx/stomp/classes/destination.html +++ b/docs/@vertx/stomp/classes/destination.html @@ -109,12 +109,12 @@

    ack

  • -

    Handles a {@code ACK} frame.

    +

    Handles a {@code ACK} frame.

    Parameters

    @@ -147,7 +147,7 @@

    destination

  • @@ -167,12 +167,12 @@

    dispatch

  • -

    Dispatches the given frame.

    +

    Dispatches the given frame.

    Parameters

    @@ -205,12 +205,12 @@

    getSubscriptions

  • -

    Gets all subscription ids for the given destination hold by the given client

    +

    Gets all subscription ids for the given destination hold by the given client

    Parameters

    @@ -237,12 +237,12 @@

    matches

  • -

    Checks whether or not the given address matches with the current destination.

    +

    Checks whether or not the given address matches with the current destination.

    Parameters

    @@ -269,12 +269,12 @@

    nack

  • -

    Handles a {@code NACK} frame.

    +

    Handles a {@code NACK} frame.

    Parameters

    @@ -307,12 +307,12 @@

    numberOfSubscriptions

  • -

    Gets the number of subscriptions attached to the current Destination.

    +

    Gets the number of subscriptions attached to the current Destination.

    Returns number

    @@ -330,12 +330,12 @@

    subscribe

  • -

    Handles a subscription request to the current Destination.

    +

    Handles a subscription request to the current Destination.

    Parameters

    @@ -368,12 +368,12 @@

    unsubscribe

  • -

    Handles a un-subscription request to the current Destination.

    +

    Handles a un-subscription request to the current Destination.

    Parameters

    @@ -406,12 +406,12 @@

    unsubscribeConnection

  • -

    Removes all subscriptions of the given connection

    +

    Removes all subscriptions of the given connection

    Parameters

    @@ -438,7 +438,7 @@

    Static bridge

  • Parameters

    @@ -464,7 +464,7 @@

    Static queue

  • Parameters

    @@ -490,7 +490,7 @@

    Static topic

  • Parameters

    diff --git a/docs/@vertx/stomp/classes/destinationfactory.html b/docs/@vertx/stomp/classes/destinationfactory.html index e34976ba8..274cccb94 100644 --- a/docs/@vertx/stomp/classes/destinationfactory.html +++ b/docs/@vertx/stomp/classes/destinationfactory.html @@ -97,12 +97,12 @@

    create

  • -

    Creates a destination for the given address.

    +

    Creates a destination for the given address.

    see
    diff --git a/docs/@vertx/stomp/classes/frame.html b/docs/@vertx/stomp/classes/frame.html index 0f634dce6..c4623dee0 100644 --- a/docs/@vertx/stomp/classes/frame.html +++ b/docs/@vertx/stomp/classes/frame.html @@ -77,120 +77,453 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    • -

    Properties

    -
    - -

    body

    -
    body: Buffer
    - -
    -
    -

    Sets the body of the frame.

    -
    -
    -
    param
    -

    the body

    -
    -
    returns
    -

    the current Frame

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns Frame

      +
      • +
    • + +

      Parameters

      + +

      Returns Frame

      +
      • +
    -
    - -

    command

    -
    command: Command
    - -
    -
    -

    Sets the frame command.

    -
    -
    -
    param
    -

    the command, must not be {@code null}

    -
    -
    returns
    -

    the current Frame

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addHeader

    +
      +
    • addHeader(headers: string): Frame
      • +
    +
      +
    • + +
      +
      +

      Sets the headers of the frames.

      +
      +
      +

      Parameters

      +
        +
      • +
        headers: string
        +
        +

        the header, may be {@code null}. In the {@code null} case, an empty map is used to store the + frame headers.

        +
        +
        • +
      +

      Returns Frame

      +

      the current Frame

      +
      • +
    -
    - -

    destination

    -
    destination: string
    - +
    + +

    getAck

    +
      +
    • getAck(): string
      • +
    +
      +
    • + +
      +
      +

      Gets the value of the {@code ack} header.

      +
      +
      +

      Returns string

      +

      the {@code ack} header value, {@code null} if not set

      +
      • +
    -
    - -

    headers

    -
    headers: string
    - -
    -
    -

    Sets the headers of the frames.

    -
    -
    -
    param
    -

    the header, may be {@code null}. In the {@code null} case, an empty map is used to store the - frame headers.

    -
    -
    returns
    -

    the current Frame

    -
    -
    -
    +
    + +

    getBody

    +
      +
    • getBody(): Buffer
      • +
    +
      +
    • + +
      +
      +

      Sets the body of the frame.

      +
      +
      +

      Returns Buffer

      +

      the current Frame

      +
      • +
    -
    - -

    id

    -
    id: string
    - +
    + +

    getBodyAsString

    +
      +
    • getBodyAsString(): string
      • +
    +
      +
    • + +
      +
      +

      Gets the body of the frames as a String encoded in the frame encoding.

      +
      +
      +

      Returns string

      +

      the body, {@code null} if none

      +
      • +
    -
    - -

    transaction

    -
    transaction: string
    - +
    + +

    getCommand

    +
      +
    • getCommand(): Command
      • +
    +
      +
    • + +
      +
      +

      Sets the frame command.

      +
      +
      +

      Returns Command

      +

      the current Frame

      +
      • +
    +
    +
    + +

    getDestination

    +
      +
    • getDestination(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getHeaders

    +
      +
    • getHeaders(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the headers of the frames.

      +
      +
      +

      Returns string

      +

      the current Frame

      +
      • +
    +
    +
    + +

    getId

    +
      +
    • getId(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getReceipt

    +
      +
    • getReceipt(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getTransaction

    +
      +
    • getTransaction(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    setBody

    +
      +
    • setBody(body: Buffer): Frame
      • +
    +
      +
    • + +
      +
      +

      Sets the body of the frame.

      +
      +
      +

      Parameters

      +
        +
      • +
        body: Buffer
        +
        +

        the body

        +
        +
        • +
      +

      Returns Frame

      +

      the current Frame

      +
      • +
    +
    +
    + +

    setCommand

    +
      +
    • setCommand(command: Command): Frame
      • +
    +
      +
    • + +
      +
      +

      Sets the frame command.

      +
      +
      +

      Parameters

      +
        +
      • +
        command: Command
        +
        +

        the command, must not be {@code null}

        +
        +
        • +
      +

      Returns Frame

      +

      the current Frame

      +
      • +
    +
    +
    + +

    setDestination

    +
      +
    • setDestination(destination: string): Frame
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        destination: string
        +
        • +
      +

      Returns Frame

      +
      • +
    +
    +
    + +

    setHeaders

    +
      +
    • setHeaders(headers: string): Frame
      • +
    +
      +
    • + +
      +
      +

      Sets the headers of the frames.

      +
      +
      +

      Parameters

      +
        +
      • +
        headers: string
        +
        +

        the header, may be {@code null}. In the {@code null} case, an empty map is used to store the + frame headers.

        +
        +
        • +
      +

      Returns Frame

      +

      the current Frame

      +
      • +
    +
    +
    + +

    setId

    +
      +
    • setId(id: string): Frame
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        id: string
        +
        • +
      +

      Returns Frame

      +
      • +
    +
    +
    + +

    setTransaction

    +
      +
    • setTransaction(transaction: string): Frame
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        transaction: string
        +
        • +
      +

      Returns Frame

      +
      • +
    @@ -221,23 +554,56 @@

    transaction

  • Frame
    • diff --git a/docs/@vertx/stomp/classes/frames.html b/docs/@vertx/stomp/classes/frames.html index 1842cf05d..62d45de6b 100644 --- a/docs/@vertx/stomp/classes/frames.html +++ b/docs/@vertx/stomp/classes/frames.html @@ -94,13 +94,13 @@

    Methods

    Static createErrorFrame

      -
    • createErrorFrame(message: string, headers: Map<String, string>, body: string): Frame
      • +
    • createErrorFrame(message: string, headers: object, body: string): Frame
    -

    Properties

    -
    - -

    acceptedVersions

    -
    acceptedVersions: string
    - -
    -
    -

    Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest - version to the highest. By default the following list is used: {@code 1.0, 1.1, 1.2}

    -
    -
    -
    param
    -

    the order list of accepted versions

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    autoComputeContentLength

    -
    autoComputeContentLength: boolean
    - -
    -
    -

    Sets whether or not the automatic computation of the {@code content-length} header is enabled. If enabled, the - {@code content-length} header is set in all frame with a body that do not explicitly set the header. The option - is enabled by default.

    -
    -
    -
    param
    -

    to enable the option, {@code false} to disable it.

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    bypassHostHeader

    -
    bypassHostHeader: boolean
    - -
    -
    -

    Sets whether or not the {@code host} header must be dropped from the {@code CONNECT/STOMP} frame. Server may - be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

    -
    -
    -
    param
    -

    to enable the option, {@code false} to disable it.

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): StompClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    getAcceptedVersions

    +
      +
    • getAcceptedVersions(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest + version to the highest. By default the following list is used: {@code 1.0, 1.1, 1.2}

      +
      +
      +

      Returns string

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    heartbeat

    -
    heartbeat: object
    - -
    -
    -

    Sets the heartbeat configuration.

    -
    -
    -
    param
    -

    the configuration

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    see
    -

    io.vertx.ext.stomp.Frame.Heartbeat

    -
    -
    -
    +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    host

    -
    host: string
    - -
    -
    -

    Sets the STOMP server host. {@code 0.0.0.0} by default.

    -
    -
    -
    param
    -

    the host name of the STOMP server

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    hostnameVerificationAlgorithm

    -
    hostnameVerificationAlgorithm: string
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getHeartbeat

    +
      +
    • getHeartbeat(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the heartbeat configuration.

      +
      +
      +
      see
      +

      io.vertx.ext.stomp.Frame.Heartbeat

      +
      +
      +
      +

      Returns object

      +

      the current StompClientOptions

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the STOMP server host. {@code 0.0.0.0} by default.

      +
      +
      +

      Returns string

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getHostnameVerificationAlgorithm

    +
      +
    • getHostnameVerificationAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    +
    +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    +
    +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getLogin

    +
      +
    • getLogin(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the login to use if the STOMP server is secured.

      +
      +
      +

      Returns string

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPasscode

    +
      +
    • getPasscode(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the passcode to use if the STOMP server is secured.

      +
      +
      +

      Returns string

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the STOMP server port. {@code 61613} by default.

      +
      +
      +

      Returns number

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +

      Returns ProxyOptions

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReconnectAttempts

    +
      +
    • getReconnectAttempts(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReconnectInterval

    +
      +
    • getReconnectInterval(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getVirtualHost

    +
      +
    • getVirtualHost(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the virtual host that will be used as "host" header value in the CONNECT frame.

      +
      +
      +

      Returns string

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    isAutoComputeContentLength

    +
      +
    • isAutoComputeContentLength(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the automatic computation of the {@code content-length} header is enabled. If enabled, the + {@code content-length} header is set in all frame with a body that do not explicitly set the header. The option + is enabled by default.

      +
      +
      +

      Returns boolean

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    isBypassHostHeader

    +
      +
    • isBypassHostHeader(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the {@code host} header must be dropped from the {@code CONNECT/STOMP} frame. Server may + be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

      +
      +
      +

      Returns boolean

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrailingLine

    +
      +
    • isTrailingLine(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by + default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

      +
      +
      +

      Returns boolean

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseStompFrame

    +
      +
    • isUseStompFrame(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not the connection is made using the {@code STOMP} command instead of the {@code CONNECT} command. + The {@code STOMP} command has been introduced in the 1.2 version of the protocol to ease the network analysis + (as {@code CONNECT} is also used by HTTP. To be compliant with server not implementing the 1.2 specification, + this option should be disabled. This option is disabled by default.

      +
      +
      +

      Returns boolean

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    setAcceptedVersions

    + +
      +
    • + +
      +
      +

      Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest + version to the highest. By default the following list is used: {@code 1.0, 1.1, 1.2}

      +
      +
      +

      Parameters

      +
        +
      • +
        acceptedVersions: string
        +
        +

        the order list of accepted versions

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    setAutoComputeContentLength

    + +
      +
    • + +
      +
      +

      Sets whether or not the automatic computation of the {@code content-length} header is enabled. If enabled, the + {@code content-length} header is set in all frame with a body that do not explicitly set the header. The option + is enabled by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        autoComputeContentLength: boolean
        +
        +

        to enable the option, {@code false} to disable it.

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    setBypassHostHeader

    + +
      +
    • + +
      +
      +

      Sets whether or not the {@code host} header must be dropped from the {@code CONNECT/STOMP} frame. Server may + be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        bypassHostHeader: boolean
        +
        +

        to enable the option, {@code false} to disable it.

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): StompClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setHeartbeat

    + +
      +
    • + +
      +
      +

      Sets the heartbeat configuration.

      +
      +
      +
      see
      +

      io.vertx.ext.stomp.Frame.Heartbeat

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        heartbeat: object
        +
        +

        the configuration

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +
      +
      +

      Sets the STOMP server host. {@code 0.0.0.0} by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        host: string
        +
        +

        the host name of the STOMP server

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    +
    +
    + +

    setHostnameVerificationAlgorithm

    +
      +
    • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): StompClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        hostnameVerificationAlgorithm: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): StompClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setLocalAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    login

    -
    login: string
    - -
    -
    -

    Sets the login to use if the STOMP server is secured.

    -
    -
    -
    param
    -

    the login

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    setLogin

    + +
      +
    • + +
      +
      +

      Sets the login to use if the STOMP server is secured.

      +
      +
      +

      Parameters

      +
        +
      • +
        login: string
        +
        +

        the login

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - +
    + +

    setMetricsName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): StompClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    passcode

    -
    passcode: string
    - -
    -
    -

    Sets the passcode to use if the STOMP server is secured.

    -
    -
    -
    param
    -

    the passcode

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    setPasscode

    + +
      +
    • + +
      +
      +

      Sets the passcode to use if the STOMP server is secured.

      +
      +
      +

      Parameters

      +
        +
      • +
        passcode: string
        +
        +

        the passcode

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Sets the STOMP server port. {@code 61613} by default.

    -
    -
    -
    param
    -

    the port

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Sets the STOMP server port. {@code 61613} by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - +
    + +

    setProxyOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    reconnectAttempts

    -
    reconnectAttempts: number
    - +
    + +

    setReconnectAttempts

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectAttempts: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    reconnectInterval

    -
    reconnectInterval: number
    - +
    + +

    setReconnectInterval

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectInterval: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    trailingLine

    -
    trailingLine: boolean
    - -
    -
    -

    Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by - default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

    -
    -
    -
    param
    -

    to add an empty line, {@code false} otherwise

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    setTrailingLine

    + +
      +
    • + +
      +
      +

      Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by + default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

      +
      +
      +

      Parameters

      +
        +
      • +
        trailingLine: boolean
        +
        +

        to add an empty line, {@code false} otherwise

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - +
    + +

    setTrustAll

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns StompClientOptions

      +
      • +
    -
    - -

    useStompFrame

    -
    useStompFrame: boolean
    - -
    -
    -

    Sets whether or not the connection is made using the {@code STOMP} command instead of the {@code CONNECT} command. - The {@code STOMP} command has been introduced in the 1.2 version of the protocol to ease the network analysis - (as {@code CONNECT} is also used by HTTP. To be compliant with server not implementing the 1.2 specification, - this option should be disabled. This option is disabled by default.

    -
    -
    -
    param
    -

    to enable the option, {@code false} to disable it.

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    setUseStompFrame

    + +
      +
    • + +
      +
      +

      Sets whether or not the connection is made using the {@code STOMP} command instead of the {@code CONNECT} command. + The {@code STOMP} command has been introduced in the 1.2 version of the protocol to ease the network analysis + (as {@code CONNECT} is also used by HTTP. To be compliant with server not implementing the 1.2 specification, + this option should be disabled. This option is disabled by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        useStompFrame: boolean
        +
        +

        to enable the option, {@code false} to disable it.

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    -
    - -

    virtualHost

    -
    virtualHost: string
    - -
    -
    -

    Sets the virtual host that will be used as "host" header value in the CONNECT frame.

    -
    -
    -
    param
    -

    the virtual host

    -
    -
    returns
    -

    the current StompClientOptions

    -
    -
    -
    +
    + +

    setVirtualHost

    + +
      +
    • + +
      +
      +

      Sets the virtual host that will be used as "host" header value in the CONNECT frame.

      +
      +
      +

      Parameters

      +
        +
      • +
        virtualHost: string
        +
        +

        the virtual host

        +
        +
        • +
      +

      Returns StompClientOptions

      +

      the current StompClientOptions

      +
      • +
    @@ -801,146 +2412,299 @@

    virtualHost

  • StompClientOptions
    • diff --git a/docs/@vertx/stomp/classes/stompserver.html b/docs/@vertx/stomp/classes/stompserver.html index e8467c86b..712266316 100644 --- a/docs/@vertx/stomp/classes/stompserver.html +++ b/docs/@vertx/stomp/classes/stompserver.html @@ -107,12 +107,12 @@

    actualPort

  • -

    Gets the port on which the server is listening. +

    Gets the port on which the server is listening.

    This is useful if you bound the server specifying 0 as port number signifying an ephemeral port.

    @@ -138,12 +138,12 @@

    close

  • -

    Closes the server.

    +

    Closes the server.

    Parameters

    @@ -156,17 +156,20 @@
    completionHandler: function
    • +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -125,12 +131,12 @@

    abortHandler

  • -

    Configures the action to execute when a {@code ABORT} frame is received.

    +

    Configures the action to execute when a {@code ABORT} frame is received.

    Parameters

    @@ -143,17 +149,20 @@
    handler: function
    • -

    Properties

    -
    - -

    acceptBacklog

    -
    acceptBacklog: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    clientAuth

    -
    clientAuth: ClientAuth
    - +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    clientAuthRequired

    -
    clientAuthRequired: boolean
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): StompServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getAcceptBacklog

    +
      +
    • getAcceptBacklog(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getClientAuth

    +
      +
    • getClientAuth(): ClientAuth
      • +
    +
      +
    • + +

      Returns ClientAuth

      +
      • +
    -
    - -

    heartbeat

    -
    heartbeat: object
    - -
    -
    -

    Sets the heartbeat configuration.

    -
    -
    -
    param
    -

    the heartbeat configuration

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    see
    -

    io.vertx.ext.stomp.Frame.Heartbeat

    -
    -
    -
    +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    host

    -
    host: string
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getHeartbeat

    +
      +
    • getHeartbeat(): object
      • +
    +
      +
    • + +
      +
      +

      Sets the heartbeat configuration.

      +
      +
      +
      see
      +

      io.vertx.ext.stomp.Frame.Heartbeat

      +
      +
      +
      +

      Returns object

      +

      the current StompServerOptions

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    maxBodyLength

    -
    maxBodyLength: number
    - -
    -
    -

    Sets the max body length accepted by the server. 10 Mb by default.

    -
    -
    -
    param
    -

    the length in bytes.

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxFrameInTransaction

    -
    maxFrameInTransaction: number
    - -
    -
    -

    Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a - transaction exceeds this threshold, the client receives an {@code ERROR} frame and is disconnected. The default - is 1000.

    -
    -
    -
    param
    -

    the max number of frame

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    maxHeaderLength

    -
    maxHeaderLength: number
    - -
    -
    -

    Sets the max header length.

    -
    -
    -
    param
    -

    the max length of headers

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    maxHeaders

    -
    maxHeaders: number
    - -
    -
    -

    Sets the maximum number of headers. 1000 by default.

    -
    -
    -
    param
    -

    the number of headers

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    maxSubscriptionsByClient

    -
    maxSubscriptionsByClient: number
    - -
    -
    -

    Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives - an error and the connection is closed.

    -
    -
    -
    param
    -

    the max number of subscriptions

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getMaxBodyLength

    +
      +
    • getMaxBodyLength(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the max body length accepted by the server. 10 Mb by default.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getMaxFrameInTransaction

    +
      +
    • getMaxFrameInTransaction(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a + transaction exceeds this threshold, the client receives an {@code ERROR} frame and is disconnected. The default + is 1000.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getMaxHeaderLength

    +
      +
    • getMaxHeaderLength(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the max header length.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getMaxHeaders

    +
      +
    • getMaxHeaders(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the maximum number of headers. 1000 by default.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getMaxSubscriptionsByClient

    +
      +
    • getMaxSubscriptionsByClient(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives + an error and the connection is closed.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the port on which the server is going to listen for TCP connection.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions.

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSupportedVersions

    +
      +
    • getSupportedVersions(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

      +
      +
      +

      Returns string

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getTimeFactor

    +
      +
    • getTimeFactor(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the time factor.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTransactionChunkSize

    +
      +
    • getTransactionChunkSize(): number
      • +
    +
      +
    • + +
      +
      +

      Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large + transactions are split into chunks, replayed one by one. This settings sets the chunk size.

      +
      +
      +

      Returns number

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getWebsocketPath

    +
      +
    • getWebsocketPath(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the websocket path. Only frames received on this path would be considered as STOMP frame.

      +
      +
      +

      Returns string

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    isClientAuthRequired

    +
      +
    • isClientAuthRequired(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSecured

    +
      +
    • isSecured(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enables or disables the server security feature. It requires an {@link io.vertx.ext.auth.AuthProvider} handler.

      +
      +
      +

      Returns boolean

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    isSendErrorOnNoSubscriptions

    +
      +
    • isSendErrorOnNoSubscriptions(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not an error is sent to the client when this client sends a message to an not subscribed + destinations (no subscriptions on this destination).

      +
      +
      +

      Returns boolean

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    isSni

    +
      +
    • isSni(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrailingLine

    +
      +
    • isTrailingLine(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by + default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

      +
      +
      +

      Returns boolean

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isWebsocketBridge

    +
      +
    • isWebsocketBridge(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enables or disables the web socket bridge.

      +
      +
      +

      Returns boolean

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setAcceptBacklog

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        acceptBacklog: number
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setClientAuth

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuth: ClientAuth
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setClientAuthRequired

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuthRequired: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): StompServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setHeartbeat

    + +
      +
    • + +
      +
      +

      Sets the heartbeat configuration.

      +
      +
      +
      see
      +

      io.vertx.ext.stomp.Frame.Heartbeat

      +
      +
      +
      +

      Parameters

      +
        +
      • +
        heartbeat: object
        +
        +

        the heartbeat configuration

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): StompServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    +
    +
    + +

    setMaxBodyLength

    + +
      +
    • + +
      +
      +

      Sets the max body length accepted by the server. 10 Mb by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxBodyLength: number
        +
        +

        the length in bytes.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setMaxFrameInTransaction

    + +
      +
    • + +
      +
      +

      Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a + transaction exceeds this threshold, the client receives an {@code ERROR} frame and is disconnected. The default + is 1000.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxFrameInTransaction: number
        +
        +

        the max number of frame

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setMaxHeaderLength

    + +
      +
    • + +
      +
      +

      Sets the max header length.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxHeaderLength: number
        +
        +

        the max length of headers

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setMaxHeaders

    + +
      +
    • + +
      +
      +

      Sets the maximum number of headers. 1000 by default.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxHeaders: number
        +
        +

        the number of headers

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setMaxSubscriptionsByClient

    + +
      +
    • + +
      +
      +

      Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives + an error and the connection is closed.

      +
      +
      +

      Parameters

      +
        +
      • +
        maxSubscriptionsByClient: number
        +
        +

        the max number of subscriptions

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): StompServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    port

    -
    port: number
    - -
    -
    -

    Sets the port on which the server is going to listen for TCP connection.

    -
    -
    -
    param
    -

    the port number, {@code -1} to disable the TCP server.

    -
    -
    returns
    -

    the current StompServerOptions.

    -
    -
    -
    +
    + +

    setPort

    + +
      +
    • + +
      +
      +

      Sets the port on which the server is going to listen for TCP connection.

      +
      +
      +

      Parameters

      +
        +
      • +
        port: number
        +
        +

        the port number, {@code -1} to disable the TCP server.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions.

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    secured

    -
    secured: boolean
    - -
    -
    -

    Enables or disables the server security feature. It requires an {@link io.vertx.ext.auth.AuthProvider} handler.

    -
    -
    -
    param
    -

    whether or not the option should be enabled.

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setSecured

    + +
      +
    • + +
      +
      +

      Enables or disables the server security feature. It requires an {@link io.vertx.ext.auth.AuthProvider} handler.

      +
      +
      +

      Parameters

      +
        +
      • +
        secured: boolean
        +
        +

        whether or not the option should be enabled.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    sendErrorOnNoSubscriptions

    -
    sendErrorOnNoSubscriptions: boolean
    - -
    -
    -

    Sets whether or not an error is sent to the client when this client sends a message to an not subscribed - destinations (no subscriptions on this destination).

    -
    -
    -
    param
    -

    whether or not the option should be enabled.

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setSendErrorOnNoSubscriptions

    +
      +
    • setSendErrorOnNoSubscriptions(sendErrorOnNoSubscriptions: boolean): StompServerOptions
      • +
    +
      +
    • + +
      +
      +

      Sets whether or not an error is sent to the client when this client sends a message to an not subscribed + destinations (no subscriptions on this destination).

      +
      +
      +

      Parameters

      +
        +
      • +
        sendErrorOnNoSubscriptions: boolean
        +
        +

        whether or not the option should be enabled.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    sni

    -
    sni: boolean
    - +
    + +

    setSni

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sni: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    supportedVersions

    -
    supportedVersions: string
    - -
    -
    -

    Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

    -
    -
    -
    param
    -

    the set of supported versions.

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setSupportedVersions

    + +
      +
    • + +
      +
      +

      Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

      +
      +
      +

      Parameters

      +
        +
      • +
        supportedVersions: string
        +
        +

        the set of supported versions.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    timeFactor

    -
    timeFactor: number
    - -
    -
    -

    Sets the time factor.

    -
    -
    -
    param
    -

    the time factor

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setTimeFactor

    + +
      +
    • + +
      +
      +

      Sets the time factor.

      +
      +
      +

      Parameters

      +
        +
      • +
        timeFactor: number
        +
        +

        the time factor

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    trailingLine

    -
    trailingLine: boolean
    - -
    -
    -

    Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by - default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

    -
    -
    -
    param
    -

    to add an empty line, {@code false} otherwise

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setTrailingLine

    + +
      +
    • + +
      +
      +

      Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by + default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

      +
      +
      +

      Parameters

      +
        +
      • +
        trailingLine: boolean
        +
        +

        to add an empty line, {@code false} otherwise

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    transactionChunkSize

    -
    transactionChunkSize: number
    - -
    -
    -

    Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large - transactions are split into chunks, replayed one by one. This settings sets the chunk size.

    -
    -
    -
    param
    -

    the size, must be strictly positive

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setTransactionChunkSize

    + +
      +
    • + +
      +
      +

      Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large + transactions are split into chunks, replayed one by one. This settings sets the chunk size.

      +
      +
      +

      Parameters

      +
        +
      • +
        transactionChunkSize: number
        +
        +

        the size, must be strictly positive

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns StompServerOptions

      +
      • +
    -
    - -

    websocketBridge

    -
    websocketBridge: boolean
    - -
    -
    -

    Enables or disables the web socket bridge.

    -
    -
    -
    param
    -

    whether or not the web socket bridge should be enabled.

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setWebsocketBridge

    + +
      +
    • + +
      +
      +

      Enables or disables the web socket bridge.

      +
      +
      +

      Parameters

      +
        +
      • +
        websocketBridge: boolean
        +
        +

        whether or not the web socket bridge should be enabled.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    -
    - -

    websocketPath

    -
    websocketPath: string
    - -
    -
    -

    Sets the websocket path. Only frames received on this path would be considered as STOMP frame.

    -
    -
    -
    param
    -

    the path, must not be {@code null}.

    -
    -
    returns
    -

    the current StompServerOptions

    -
    -
    -
    +
    + +

    setWebsocketPath

    + +
      +
    • + +
      +
      +

      Sets the websocket path. Only frames received on this path would be considered as STOMP frame.

      +
      +
      +

      Parameters

      +
        +
      • +
        websocketPath: string
        +
        +

        the path, must not be {@code null}.

        +
        +
        • +
      +

      Returns StompServerOptions

      +

      the current StompServerOptions

      +
      • +
    @@ -874,149 +2522,305 @@

    websocketPath

  • StompServerOptions
    • diff --git a/docs/@vertx/tcp-eventbus-bridge/assets/js/search.js b/docs/@vertx/tcp-eventbus-bridge/assets/js/search.js index f7ee71316..d5af4b11e 100644 --- a/docs/@vertx/tcp-eventbus-bridge/assets/js/search.js +++ b/docs/@vertx/tcp-eventbus-bridge/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"BridgeEvent","url":"classes/bridgeevent.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"setHandler","url":"classes/bridgeevent.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":2,"kind":2048,"name":"complete","url":"classes/bridgeevent.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":3,"kind":2048,"name":"tryComplete","url":"classes/bridgeevent.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":4,"kind":2048,"name":"result","url":"classes/bridgeevent.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":5,"kind":2048,"name":"compose","url":"classes/bridgeevent.html#compose","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":6,"kind":2048,"name":"map","url":"classes/bridgeevent.html#map","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":7,"kind":2048,"name":"completer","url":"classes/bridgeevent.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":8,"kind":2048,"name":"recover","url":"classes/bridgeevent.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":9,"kind":2048,"name":"otherwise","url":"classes/bridgeevent.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":10,"kind":2048,"name":"otherwiseEmpty","url":"classes/bridgeevent.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":11,"kind":2048,"name":"setRawMessage","url":"classes/bridgeevent.html#setrawmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":12,"kind":2048,"name":"socket","url":"classes/bridgeevent.html#socket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":13,"kind":128,"name":"TcpEventBusBridge","url":"classes/tcpeventbusbridge.html","classes":"tsd-kind-class"},{"id":14,"kind":2048,"name":"create","url":"classes/tcpeventbusbridge.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TcpEventBusBridge"},{"id":15,"kind":2048,"name":"listen","url":"classes/tcpeventbusbridge.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TcpEventBusBridge"},{"id":16,"kind":2048,"name":"close","url":"classes/tcpeventbusbridge.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TcpEventBusBridge"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"BridgeEvent","url":"classes/bridgeevent.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"setHandler","url":"classes/bridgeevent.html#sethandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":2,"kind":2048,"name":"complete","url":"classes/bridgeevent.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":3,"kind":2048,"name":"tryComplete","url":"classes/bridgeevent.html#trycomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":4,"kind":2048,"name":"result","url":"classes/bridgeevent.html#result","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":5,"kind":2048,"name":"compose","url":"classes/bridgeevent.html#compose","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"BridgeEvent"},{"id":6,"kind":2048,"name":"map","url":"classes/bridgeevent.html#map","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"BridgeEvent"},{"id":7,"kind":2048,"name":"completer","url":"classes/bridgeevent.html#completer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":8,"kind":2048,"name":"recover","url":"classes/bridgeevent.html#recover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":9,"kind":2048,"name":"otherwise","url":"classes/bridgeevent.html#otherwise","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":10,"kind":2048,"name":"otherwiseEmpty","url":"classes/bridgeevent.html#otherwiseempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":11,"kind":2048,"name":"setRawMessage","url":"classes/bridgeevent.html#setrawmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":12,"kind":2048,"name":"socket","url":"classes/bridgeevent.html#socket","classes":"tsd-kind-method tsd-parent-kind-class","parent":"BridgeEvent"},{"id":13,"kind":128,"name":"TcpEventBusBridge","url":"classes/tcpeventbusbridge.html","classes":"tsd-kind-class"},{"id":14,"kind":2048,"name":"create","url":"classes/tcpeventbusbridge.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TcpEventBusBridge"},{"id":15,"kind":2048,"name":"listen","url":"classes/tcpeventbusbridge.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TcpEventBusBridge"},{"id":16,"kind":2048,"name":"close","url":"classes/tcpeventbusbridge.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TcpEventBusBridge"}]}; \ No newline at end of file diff --git a/docs/@vertx/tcp-eventbus-bridge/classes/bridgeevent.html b/docs/@vertx/tcp-eventbus-bridge/classes/bridgeevent.html index 064cc3d21..c0195e2b3 100644 --- a/docs/@vertx/tcp-eventbus-bridge/classes/bridgeevent.html +++ b/docs/@vertx/tcp-eventbus-bridge/classes/bridgeevent.html @@ -68,7 +68,12 @@

    Class BridgeEvent

    Hierarchy

    • - BridgeEvent + any +
        +
      • + BridgeEvent +
        • +
    @@ -81,8 +86,8 @@

    Methods

    • complete
    • completer
      • -
    • compose
      • -
    • map
      • +
    • compose
      • +
    • map
    • otherwise
    • otherwiseEmpty
    • recover
      • @@ -108,7 +113,7 @@

      complete

    • Parameters

      @@ -131,24 +136,27 @@

      completer

    • Returns function

        • -
        • (result: AsyncResult): void
          • +
        • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>

        • Parameters

          • -
            result: AsyncResult
            +
            res: AsyncResult<boolean>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<boolean>> +

        • @@ -156,20 +164,26 @@

        Returns void

    -
    +

    compose

    -
      -
    • compose(handler: function, next: Future): Future
      • -
    • compose(mapper: function): Future
      • +
        +
      • compose<U>(handler: function, next: Future<U>): Future<U>
        • +
      • compose<U>(mapper: function): Future<U>
      • +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • @@ -177,34 +191,43 @@
          handler: function
            • -
            • (result: boolean): void
              • +
            • (res: boolean): void | Handler<boolean>

            • Parameters

              • -
                result: boolean
                +
                res: boolean
              -

              Returns void

              +

              Returns void + | + Handler<boolean> +

        • -
          next: Future
          +
          next: Future<U>
        -

        Returns Future

        +

        Returns Future<U>

      • +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • @@ -212,40 +235,46 @@
          mapper: function
            • -
            • (t: boolean): Future
              • +
            • (arg: boolean): Future<U>

            • Parameters

              • -
                t: boolean
                +
                arg: boolean
              -

              Returns Future

              +

              Returns Future<U>

        -

        Returns Future

        +

        Returns Future<U>

    -
    +

    map

    -
      -
    • map(mapper: function): Future
      • +
        +
      • map<U>(mapper: function): Future<U>
      • +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • @@ -253,24 +282,24 @@
          mapper: function
            • -
            • (t: boolean): any
              • +
            • (arg: boolean): U

            • Parameters

              • -
                t: boolean
                +
                arg: boolean
              -

              Returns any

              +

              Returns U

        -

        Returns Future

        +

        Returns Future<U>

    @@ -278,14 +307,14 @@

    Returns Future

    otherwise

      -
    • otherwise(mapper: function): Future
      • -
    • otherwise(value: boolean): Future
      • +
    • otherwise(mapper: function): Future<boolean>
      • +
    • otherwise(value: boolean): Future<boolean>

    • Parameters

      @@ -295,14 +324,14 @@
      mapper: function
        • -
        • (t: Error): boolean
          • +
        • (arg: Error): boolean

        • Parameters

          • -
            t: Error
            +
            arg: Error

          Returns boolean

          @@ -312,12 +341,12 @@

          Returns boolean

        -

        Returns Future

        +

        Returns Future<boolean>

      • Parameters

        @@ -326,7 +355,7 @@

        Parameters

        value: boolean
      -

      Returns Future

      +

      Returns Future<boolean>

    @@ -334,16 +363,16 @@

    Returns Future

    otherwiseEmpty

      -
    • otherwiseEmpty(): Future
      • +
    • otherwiseEmpty(): Future<boolean>
    • -

      Returns Future

      +

      Returns Future<boolean>

    @@ -351,13 +380,13 @@

    Returns Future

    recover

      -
    • recover(mapper: function): Future
      • +
    • recover(mapper: function): Future<boolean>

    • Parameters

      @@ -367,24 +396,24 @@
      mapper: function
        • -
        • (t: Error): Future
          • +
        • (arg: Error): Future<boolean>

        • Parameters

          • -
            t: Error
            +
            arg: Error
          -

          Returns Future

          +

          Returns Future<boolean>

    -

    Returns Future

    +

    Returns Future<boolean>

    @@ -398,7 +427,7 @@

    result

  • Returns boolean

    @@ -409,13 +438,13 @@

    Returns boolean

    setHandler

      -
    • setHandler(arg0: function): Future
      • +
    • setHandler(arg0: function): Future<boolean>

    • Parameters

      @@ -425,24 +454,27 @@
      arg0: function
        • -
        • (result: AsyncResult<boolean>): void
          • +
        • (res: AsyncResult<boolean>): void | Handler<AsyncResult<boolean>>

        • Parameters

          • -
            result: AsyncResult<boolean>
            +
            res: AsyncResult<boolean>
          -

          Returns void

          +

          Returns void + | + Handler<AsyncResult<boolean>> +

    -

    Returns Future

    +

    Returns Future<boolean>

    • @@ -456,12 +488,12 @@

    setRawMessage

  • -

    Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is +

    Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved.

    @@ -472,6 +504,11 @@
    message: object

    the raw message

    +
      +
    • +
      [key: string]: any
      +
      • +

    • Returns BridgeEvent

    @@ -489,12 +526,12 @@

    socket

  • -

    Get the SockJSSocket instance corresponding to the event

    +

    Get the SockJSSocket instance corresponding to the event

    Returns NetSocket

    @@ -512,7 +549,7 @@

    tryComplete

  • Parameters

    @@ -548,10 +585,10 @@

    Returns boolean completer

    • -
  • +
  • compose
    • -
  • +
  • map
  • diff --git a/docs/@vertx/tcp-eventbus-bridge/classes/tcpeventbusbridge.html b/docs/@vertx/tcp-eventbus-bridge/classes/tcpeventbusbridge.html index d0900f9f4..c9530f375 100644 --- a/docs/@vertx/tcp-eventbus-bridge/classes/tcpeventbusbridge.html +++ b/docs/@vertx/tcp-eventbus-bridge/classes/tcpeventbusbridge.html @@ -100,12 +100,12 @@

    close

  • -

    Close the current socket.

    +

    Close the current socket.

    Parameters

    @@ -118,17 +118,20 @@
    handler: function
      • -
      • (result: AsyncResult<void>): void
        • +
      • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

      • Parameters

        • -
          result: AsyncResult<void>
          +
          res: AsyncResult<void>
        -

        Returns void

        +

        Returns void + | + Handler<AsyncResult<void>> +

      • @@ -140,12 +143,12 @@

      Returns void
      -

      Close the current socket.

      +

      Close the current socket.

      Returns void

      @@ -167,12 +170,12 @@

      listen

    • -

      Listen on default port 7000

      +

      Listen on default port 7000

      Returns TcpEventBusBridge

      @@ -181,12 +184,12 @@

      Returns
      -

      Listen on default port 7000 with a handler to report the state of the socket listen operation.

      +

      Listen on default port 7000 with a handler to report the state of the socket listen operation.

      Parameters

      @@ -199,17 +202,20 @@
      handler: function
        • @@ -222,12 +228,12 @@

        Returns
        -

        Listen on specific port and bind to specific address

        +

        Listen on specific port and bind to specific address

        Parameters

        @@ -251,12 +257,12 @@

        Returns
        -

        Listen on specific port and bind to specific address

        +

        Listen on specific port and bind to specific address

        Parameters

        @@ -281,17 +287,20 @@
        handler: function
          • @@ -304,12 +313,12 @@

          Returns
          -

          Listen on specific port

          +

          Listen on specific port

          Parameters

          @@ -327,12 +336,12 @@

          Returns
          -

          Listen on specific port

          +

          Listen on specific port

          Parameters

          @@ -351,17 +360,20 @@
          handler: function
            • @@ -386,7 +398,7 @@

            Static create

          • Parameters

            @@ -400,7 +412,7 @@

            Returns

            Parameters

            @@ -417,7 +429,7 @@

            Returns

            Parameters

            @@ -437,7 +449,7 @@

            Returns

            Parameters

            @@ -456,17 +468,20 @@
            eventHandler: function
              • diff --git a/docs/@vertx/unit/assets/js/search.js b/docs/@vertx/unit/assets/js/search.js index 5113ca69c..06c14faf5 100644 --- a/docs/@vertx/unit/assets/js/search.js +++ b/docs/@vertx/unit/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"ReportOptions","url":"classes/reportoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"format","url":"classes/reportoptions.html#format","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ReportOptions"},{"id":2,"kind":1024,"name":"to","url":"classes/reportoptions.html#to","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ReportOptions"},{"id":3,"kind":128,"name":"ReportingOptions","url":"classes/reportingoptions.html","classes":"tsd-kind-class"},{"id":4,"kind":1024,"name":"reporters","url":"classes/reportingoptions.html#reporters","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ReportingOptions"},{"id":5,"kind":128,"name":"TestOptions","url":"classes/testoptions.html","classes":"tsd-kind-class"},{"id":6,"kind":1024,"name":"reporters","url":"classes/testoptions.html#reporters","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TestOptions"},{"id":7,"kind":1024,"name":"timeout","url":"classes/testoptions.html#timeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TestOptions"},{"id":8,"kind":1024,"name":"useEventLoop","url":"classes/testoptions.html#useeventloop","classes":"tsd-kind-property tsd-parent-kind-class","parent":"TestOptions"},{"id":9,"kind":128,"name":"Async","url":"classes/async.html","classes":"tsd-kind-class"},{"id":10,"kind":2048,"name":"resolve","url":"classes/async.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":11,"kind":2048,"name":"handler","url":"classes/async.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":12,"kind":2048,"name":"count","url":"classes/async.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":13,"kind":2048,"name":"countDown","url":"classes/async.html#countdown","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":14,"kind":2048,"name":"complete","url":"classes/async.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":15,"kind":128,"name":"Completion","url":"classes/completion.html","classes":"tsd-kind-class"},{"id":16,"kind":2048,"name":"resolve","url":"classes/completion.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":17,"kind":2048,"name":"isCompleted","url":"classes/completion.html#iscompleted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":18,"kind":2048,"name":"isSucceeded","url":"classes/completion.html#issucceeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":19,"kind":2048,"name":"isFailed","url":"classes/completion.html#isfailed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":20,"kind":2048,"name":"handler","url":"classes/completion.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":21,"kind":2048,"name":"await","url":"classes/completion.html#await","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":22,"kind":2048,"name":"awaitSuccess","url":"classes/completion.html#awaitsuccess","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":23,"kind":128,"name":"EventBusCollector","url":"classes/eventbuscollector.html","classes":"tsd-kind-class"},{"id":24,"kind":2048,"name":"create","url":"classes/eventbuscollector.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"EventBusCollector"},{"id":25,"kind":2048,"name":"register","url":"classes/eventbuscollector.html#register","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusCollector"},{"id":26,"kind":128,"name":"Failure","url":"classes/failure.html","classes":"tsd-kind-class"},{"id":27,"kind":2048,"name":"isError","url":"classes/failure.html#iserror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Failure"},{"id":28,"kind":2048,"name":"message","url":"classes/failure.html#message","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Failure"},{"id":29,"kind":2048,"name":"stackTrace","url":"classes/failure.html#stacktrace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Failure"},{"id":30,"kind":128,"name":"TestCase","url":"classes/testcase.html","classes":"tsd-kind-class"},{"id":31,"kind":2048,"name":"create","url":"classes/testcase.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TestCase"},{"id":32,"kind":128,"name":"TestCaseReport","url":"classes/testcasereport.html","classes":"tsd-kind-class"},{"id":33,"kind":2048,"name":"name","url":"classes/testcasereport.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestCaseReport"},{"id":34,"kind":2048,"name":"endHandler","url":"classes/testcasereport.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestCaseReport"},{"id":35,"kind":128,"name":"TestCompletion","url":"classes/testcompletion.html","classes":"tsd-kind-class"},{"id":36,"kind":2048,"name":"resolve","url":"classes/testcompletion.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestCompletion"},{"id":37,"kind":2048,"name":"handler","url":"classes/testcompletion.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestCompletion"},{"id":38,"kind":128,"name":"TestContext","url":"classes/testcontext.html","classes":"tsd-kind-class"},{"id":39,"kind":2048,"name":"get","url":"classes/testcontext.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":40,"kind":2048,"name":"put","url":"classes/testcontext.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":41,"kind":2048,"name":"remove","url":"classes/testcontext.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":42,"kind":2048,"name":"assertNull","url":"classes/testcontext.html#assertnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":43,"kind":2048,"name":"assertNotNull","url":"classes/testcontext.html#assertnotnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":44,"kind":2048,"name":"assertTrue","url":"classes/testcontext.html#asserttrue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":45,"kind":2048,"name":"assertFalse","url":"classes/testcontext.html#assertfalse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":46,"kind":2048,"name":"assertEquals","url":"classes/testcontext.html#assertequals","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":47,"kind":2048,"name":"assertInRange","url":"classes/testcontext.html#assertinrange","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":48,"kind":2048,"name":"assertNotEquals","url":"classes/testcontext.html#assertnotequals","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":49,"kind":2048,"name":"verify","url":"classes/testcontext.html#verify","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":50,"kind":2048,"name":"fail","url":"classes/testcontext.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":51,"kind":2048,"name":"async","url":"classes/testcontext.html#async","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":52,"kind":2048,"name":"strictAsync","url":"classes/testcontext.html#strictasync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":53,"kind":2048,"name":"asyncAssertSuccess","url":"classes/testcontext.html#asyncassertsuccess","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":54,"kind":2048,"name":"asyncAssertFailure","url":"classes/testcontext.html#asyncassertfailure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":55,"kind":2048,"name":"exceptionHandler","url":"classes/testcontext.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":56,"kind":128,"name":"TestResult","url":"classes/testresult.html","classes":"tsd-kind-class"},{"id":57,"kind":2048,"name":"name","url":"classes/testresult.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":58,"kind":2048,"name":"beginTime","url":"classes/testresult.html#begintime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":59,"kind":2048,"name":"durationTime","url":"classes/testresult.html#durationtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":60,"kind":2048,"name":"succeeded","url":"classes/testresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":61,"kind":2048,"name":"failed","url":"classes/testresult.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":62,"kind":2048,"name":"failure","url":"classes/testresult.html#failure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":63,"kind":128,"name":"TestSuite","url":"classes/testsuite.html","classes":"tsd-kind-class"},{"id":64,"kind":2048,"name":"create","url":"classes/testsuite.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TestSuite"},{"id":65,"kind":2048,"name":"before","url":"classes/testsuite.html#before","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":66,"kind":2048,"name":"beforeEach","url":"classes/testsuite.html#beforeeach","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":67,"kind":2048,"name":"after","url":"classes/testsuite.html#after","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":68,"kind":2048,"name":"afterEach","url":"classes/testsuite.html#aftereach","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":69,"kind":2048,"name":"test","url":"classes/testsuite.html#test","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":70,"kind":2048,"name":"run","url":"classes/testsuite.html#run","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":71,"kind":128,"name":"TestSuiteReport","url":"classes/testsuitereport.html","classes":"tsd-kind-class"},{"id":72,"kind":2048,"name":"name","url":"classes/testsuitereport.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":73,"kind":2048,"name":"exceptionHandler","url":"classes/testsuitereport.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":74,"kind":2048,"name":"handler","url":"classes/testsuitereport.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":75,"kind":2048,"name":"pause","url":"classes/testsuitereport.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":76,"kind":2048,"name":"resume","url":"classes/testsuitereport.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":77,"kind":2048,"name":"endHandler","url":"classes/testsuitereport.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"ReportOptions","url":"classes/reportoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/reportoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ReportOptions"},{"id":2,"kind":2048,"name":"getFormat","url":"classes/reportoptions.html#getformat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportOptions"},{"id":3,"kind":2048,"name":"setFormat","url":"classes/reportoptions.html#setformat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportOptions"},{"id":4,"kind":2048,"name":"getTo","url":"classes/reportoptions.html#getto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportOptions"},{"id":5,"kind":2048,"name":"setTo","url":"classes/reportoptions.html#setto","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportOptions"},{"id":6,"kind":128,"name":"ReportingOptions","url":"classes/reportingoptions.html","classes":"tsd-kind-class"},{"id":7,"kind":512,"name":"constructor","url":"classes/reportingoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ReportingOptions"},{"id":8,"kind":2048,"name":"getReporters","url":"classes/reportingoptions.html#getreporters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportingOptions"},{"id":9,"kind":2048,"name":"setReporters","url":"classes/reportingoptions.html#setreporters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportingOptions"},{"id":10,"kind":2048,"name":"addReporter","url":"classes/reportingoptions.html#addreporter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ReportingOptions"},{"id":11,"kind":128,"name":"TestOptions","url":"classes/testoptions.html","classes":"tsd-kind-class"},{"id":12,"kind":512,"name":"constructor","url":"classes/testoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"TestOptions"},{"id":13,"kind":2048,"name":"getReporters","url":"classes/testoptions.html#getreporters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":14,"kind":2048,"name":"setReporters","url":"classes/testoptions.html#setreporters","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":15,"kind":2048,"name":"addReporter","url":"classes/testoptions.html#addreporter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":16,"kind":2048,"name":"getTimeout","url":"classes/testoptions.html#gettimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":17,"kind":2048,"name":"setTimeout","url":"classes/testoptions.html#settimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":18,"kind":2048,"name":"isUseEventLoop","url":"classes/testoptions.html#isuseeventloop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":19,"kind":2048,"name":"setUseEventLoop","url":"classes/testoptions.html#setuseeventloop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestOptions"},{"id":20,"kind":128,"name":"Async","url":"classes/async.html","classes":"tsd-kind-class"},{"id":21,"kind":2048,"name":"resolve","url":"classes/async.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Async"},{"id":22,"kind":2048,"name":"handler","url":"classes/async.html#handler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Async"},{"id":23,"kind":2048,"name":"count","url":"classes/async.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":24,"kind":2048,"name":"countDown","url":"classes/async.html#countdown","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":25,"kind":2048,"name":"complete","url":"classes/async.html#complete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Async"},{"id":26,"kind":2048,"name":"isCompleted","url":"classes/async.html#iscompleted","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Async"},{"id":27,"kind":2048,"name":"isSucceeded","url":"classes/async.html#issucceeded","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Async"},{"id":28,"kind":2048,"name":"isFailed","url":"classes/async.html#isfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Async"},{"id":29,"kind":2048,"name":"await","url":"classes/async.html#await","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Async"},{"id":30,"kind":2048,"name":"awaitSuccess","url":"classes/async.html#awaitsuccess","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"Async"},{"id":31,"kind":128,"name":"Completion","url":"classes/completion.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":32,"kind":2048,"name":"resolve","url":"classes/completion.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":33,"kind":2048,"name":"isCompleted","url":"classes/completion.html#iscompleted","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":34,"kind":2048,"name":"isSucceeded","url":"classes/completion.html#issucceeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":35,"kind":2048,"name":"isFailed","url":"classes/completion.html#isfailed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":36,"kind":2048,"name":"handler","url":"classes/completion.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":37,"kind":2048,"name":"await","url":"classes/completion.html#await","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":38,"kind":2048,"name":"awaitSuccess","url":"classes/completion.html#awaitsuccess","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Completion"},{"id":39,"kind":128,"name":"EventBusCollector","url":"classes/eventbuscollector.html","classes":"tsd-kind-class"},{"id":40,"kind":2048,"name":"create","url":"classes/eventbuscollector.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"EventBusCollector"},{"id":41,"kind":2048,"name":"register","url":"classes/eventbuscollector.html#register","classes":"tsd-kind-method tsd-parent-kind-class","parent":"EventBusCollector"},{"id":42,"kind":128,"name":"Failure","url":"classes/failure.html","classes":"tsd-kind-class"},{"id":43,"kind":2048,"name":"isError","url":"classes/failure.html#iserror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Failure"},{"id":44,"kind":2048,"name":"message","url":"classes/failure.html#message","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Failure"},{"id":45,"kind":2048,"name":"stackTrace","url":"classes/failure.html#stacktrace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Failure"},{"id":46,"kind":128,"name":"TestCase","url":"classes/testcase.html","classes":"tsd-kind-class"},{"id":47,"kind":2048,"name":"create","url":"classes/testcase.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TestCase"},{"id":48,"kind":128,"name":"TestCaseReport","url":"classes/testcasereport.html","classes":"tsd-kind-class"},{"id":49,"kind":2048,"name":"name","url":"classes/testcasereport.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestCaseReport"},{"id":50,"kind":2048,"name":"endHandler","url":"classes/testcasereport.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestCaseReport"},{"id":51,"kind":128,"name":"TestCompletion","url":"classes/testcompletion.html","classes":"tsd-kind-class"},{"id":52,"kind":2048,"name":"resolve","url":"classes/testcompletion.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"TestCompletion"},{"id":53,"kind":2048,"name":"handler","url":"classes/testcompletion.html#handler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"TestCompletion"},{"id":54,"kind":2048,"name":"isCompleted","url":"classes/testcompletion.html#iscompleted","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"TestCompletion"},{"id":55,"kind":2048,"name":"isSucceeded","url":"classes/testcompletion.html#issucceeded","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"TestCompletion"},{"id":56,"kind":2048,"name":"isFailed","url":"classes/testcompletion.html#isfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"TestCompletion"},{"id":57,"kind":2048,"name":"await","url":"classes/testcompletion.html#await","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"TestCompletion"},{"id":58,"kind":2048,"name":"awaitSuccess","url":"classes/testcompletion.html#awaitsuccess","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"TestCompletion"},{"id":59,"kind":128,"name":"TestContext","url":"classes/testcontext.html","classes":"tsd-kind-class"},{"id":60,"kind":2048,"name":"get","url":"classes/testcontext.html#get","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"TestContext"},{"id":61,"kind":2048,"name":"put","url":"classes/testcontext.html#put","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"TestContext"},{"id":62,"kind":2048,"name":"remove","url":"classes/testcontext.html#remove","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"TestContext"},{"id":63,"kind":2048,"name":"assertNull","url":"classes/testcontext.html#assertnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":64,"kind":2048,"name":"assertNotNull","url":"classes/testcontext.html#assertnotnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":65,"kind":2048,"name":"assertTrue","url":"classes/testcontext.html#asserttrue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":66,"kind":2048,"name":"assertFalse","url":"classes/testcontext.html#assertfalse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":67,"kind":2048,"name":"assertEquals","url":"classes/testcontext.html#assertequals","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":68,"kind":2048,"name":"assertInRange","url":"classes/testcontext.html#assertinrange","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":69,"kind":2048,"name":"assertNotEquals","url":"classes/testcontext.html#assertnotequals","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":70,"kind":2048,"name":"verify","url":"classes/testcontext.html#verify","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":71,"kind":2048,"name":"fail","url":"classes/testcontext.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":72,"kind":2048,"name":"async","url":"classes/testcontext.html#async","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":73,"kind":2048,"name":"strictAsync","url":"classes/testcontext.html#strictasync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":74,"kind":2048,"name":"asyncAssertSuccess","url":"classes/testcontext.html#asyncassertsuccess","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"TestContext"},{"id":75,"kind":2048,"name":"asyncAssertFailure","url":"classes/testcontext.html#asyncassertfailure","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"TestContext"},{"id":76,"kind":2048,"name":"exceptionHandler","url":"classes/testcontext.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestContext"},{"id":77,"kind":128,"name":"TestResult","url":"classes/testresult.html","classes":"tsd-kind-class"},{"id":78,"kind":2048,"name":"name","url":"classes/testresult.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":79,"kind":2048,"name":"beginTime","url":"classes/testresult.html#begintime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":80,"kind":2048,"name":"durationTime","url":"classes/testresult.html#durationtime","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":81,"kind":2048,"name":"succeeded","url":"classes/testresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":82,"kind":2048,"name":"failed","url":"classes/testresult.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":83,"kind":2048,"name":"failure","url":"classes/testresult.html#failure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestResult"},{"id":84,"kind":128,"name":"TestSuite","url":"classes/testsuite.html","classes":"tsd-kind-class"},{"id":85,"kind":2048,"name":"create","url":"classes/testsuite.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"TestSuite"},{"id":86,"kind":2048,"name":"before","url":"classes/testsuite.html#before","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":87,"kind":2048,"name":"beforeEach","url":"classes/testsuite.html#beforeeach","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":88,"kind":2048,"name":"after","url":"classes/testsuite.html#after","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":89,"kind":2048,"name":"afterEach","url":"classes/testsuite.html#aftereach","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":90,"kind":2048,"name":"test","url":"classes/testsuite.html#test","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":91,"kind":2048,"name":"run","url":"classes/testsuite.html#run","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuite"},{"id":92,"kind":128,"name":"TestSuiteReport","url":"classes/testsuitereport.html","classes":"tsd-kind-class"},{"id":93,"kind":2048,"name":"fetch","url":"classes/testsuitereport.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":94,"kind":2048,"name":"name","url":"classes/testsuitereport.html#name","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":95,"kind":2048,"name":"exceptionHandler","url":"classes/testsuitereport.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":96,"kind":2048,"name":"handler","url":"classes/testsuitereport.html#handler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":97,"kind":2048,"name":"pause","url":"classes/testsuitereport.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":98,"kind":2048,"name":"resume","url":"classes/testsuitereport.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"},{"id":99,"kind":2048,"name":"endHandler","url":"classes/testsuitereport.html#endhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"TestSuiteReport"}]}; \ No newline at end of file diff --git a/docs/@vertx/unit/classes/async.html b/docs/@vertx/unit/classes/async.html index a92011187..23fe982cf 100644 --- a/docs/@vertx/unit/classes/async.html +++ b/docs/@vertx/unit/classes/async.html @@ -68,7 +68,12 @@

              Class Async

              Hierarchy

    • @@ -79,11 +84,16 @@

    Index

    Methods

    @@ -91,6 +101,104 @@

    Methods

    Methods

    +
    + +

    await

    +
      +
    • await(): void
      • +
    • await(timeoutMillis: number): void
      • +
    +
      +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes.

      +
      +

      If the current thread is interrupted, an exception will be thrown.

      +
      +

      Returns void

      +
      • +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes with a configurable timeout.

      +
      +

      If completion times out or the current thread is interrupted, an exception will be thrown.

      +
      +

      Parameters

      +
        +
      • +
        timeoutMillis: number
        +
        +

        the timeout in milliseconds

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    awaitSuccess

    +
      +
    • awaitSuccess(): void
      • +
    • awaitSuccess(timeoutMillis: number): void
      • +
    +
      +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes and succeeds.

      +
      +

      If the current thread is interrupted or the suite fails, an exception will be thrown.

      +
      +

      Returns void

      +
      • +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

      +
      +

      If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown.

      +
      +

      Parameters

      +
        +
      • +
        timeoutMillis: number
        +
        +

        the timeout in milliseconds

        +
        +
        • +
      +

      Returns void

      +
      • +
    +

    complete

    @@ -101,12 +209,12 @@

    complete

  • -

    Signals the asynchronous operation is done, this method must be called with a count greater than {@code 0}, +

    Signals the asynchronous operation is done, this method must be called with a count greater than {@code 0}, otherwise it throws an {@code IllegalStateException} to signal the error.

    @@ -124,7 +232,7 @@

    count

  • @@ -144,12 +252,12 @@

    countDown

  • -

    Count down the async.

    +

    Count down the async.

    throws
    @@ -161,22 +269,23 @@

    Returns void

    • -
    +

    handler

    -
      +
      • handler(completionHandler: function): void
      • -

        Completion handler to receive a completion signal when this completions completes.

        +

        Completion handler to receive a completion signal when this completions completes.

        Parameters

        @@ -189,17 +298,20 @@
        completionHandler: function
          • -
          • (result: AsyncResult<void>): void
            • +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

          • Parameters

            • -
              result: AsyncResult<void>
              +
              res: AsyncResult<void>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<void>> +

          • @@ -210,28 +322,92 @@

          Returns void

    -
    +
    + +

    isCompleted

    +
      +
    • isCompleted(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if this completion is completed

      +
      • +
    +
    +
    + +

    isFailed

    +
      +
    • isFailed(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if the this completion is completed and failed

      +
      • +
    +
    +
    + +

    isSucceeded

    +
      +
    • isSucceeded(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if this completion is completed and succeeded

      +
      • +
    +
    +

    resolve

    -
      -
    • resolve(future: Future): void
      • +
        +
      • resolve(future: Future<void>): void
      • -

        Completes the future upon completion, otherwise fails it.

        +

        Completes the future upon completion, otherwise fails it.

        Parameters

          -
        • +
        • Completion
        • diff --git a/docs/@vertx/unit/classes/completion.html b/docs/@vertx/unit/classes/completion.html index 141a17d49..7da2ddf96 100644 --- a/docs/@vertx/unit/classes/completion.html +++ b/docs/@vertx/unit/classes/completion.html @@ -57,18 +57,34 @@ Completion
        -

        Class Completion

        +

        Class Completion<T>

        +
        +

        Type parameters

        +
          +
        • +

          T

          +
          • +
        +

        Hierarchy

        @@ -104,12 +120,12 @@

        await

      • -

        Cause the current thread to wait until this completion completes.

        +

        Cause the current thread to wait until this completion completes.

        If the current thread is interrupted, an exception will be thrown.

        @@ -118,12 +134,12 @@

        Returns void
        -

        Cause the current thread to wait until this completion completes with a configurable timeout.

        +

        Cause the current thread to wait until this completion completes with a configurable timeout.

        If completion times out or the current thread is interrupted, an exception will be thrown.

        @@ -151,12 +167,12 @@

        awaitSuccess

      • -

        Cause the current thread to wait until this completion completes and succeeds.

        +

        Cause the current thread to wait until this completion completes and succeeds.

        If the current thread is interrupted or the suite fails, an exception will be thrown.

        @@ -165,12 +181,12 @@

        Returns void
        -

        Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

        +

        Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

        If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown.

        @@ -197,12 +213,12 @@

        handler

      • -

        Completion handler to receive a completion signal when this completions completes.

        +

        Completion handler to receive a completion signal when this completions completes.

        Parameters

        @@ -215,17 +231,20 @@
        completionHandler: function
          • -
          • (result: AsyncResult<any>): void
            • +
          • (res: AsyncResult<T>): void | Handler<AsyncResult<T>>

          • Parameters

            • -
              result: AsyncResult<any>
              +
              res: AsyncResult<T>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<T>> +

          • @@ -246,7 +265,7 @@

          isCompleted

        • @@ -266,7 +285,7 @@

          isFailed

        • @@ -286,7 +305,7 @@

          isSucceeded

        • @@ -300,24 +319,24 @@

          Returns boolean

          resolve

            -
          • resolve(future: Future): void
            • +
          • resolve(future: Future<T>): void
          • -

            Completes the future upon completion, otherwise fails it.

            +

            Completes the future upon completion, otherwise fails it.

            Parameters

            • -
              future: Future
              +
              future: Future<T>

              the future to resolve

              @@ -344,7 +363,7 @@

              Returns void

              -
            • +
            • Completion
              • diff --git a/docs/@vertx/unit/classes/eventbuscollector.html b/docs/@vertx/unit/classes/eventbuscollector.html index a91443cee..70592c366 100644 --- a/docs/@vertx/unit/classes/eventbuscollector.html +++ b/docs/@vertx/unit/classes/eventbuscollector.html @@ -92,18 +92,18 @@

                Methods

                register

                  -
                • register(address: string): MessageConsumer
                  • +
                • register(address: string): MessageConsumer<any>
                • -

                  Register the collector as a consumer of the event bus with the specified address.

                  +

                  Register the collector as a consumer of the event bus with the specified address.

                  Parameters

                  @@ -115,7 +115,7 @@
                  address: string

        -

        Returns MessageConsumer

        +

        Returns MessageConsumer<any>

        the subscribed message consumer

      @@ -131,12 +131,12 @@

      Static create

    • -

      Create a message handler reporting with the specified options. The returned +

      Create a message handler reporting with the specified options. The returned message handler can be registered to an event bus.

      @@ -158,7 +158,7 @@

      Returns

      Parameters

      @@ -171,17 +171,20 @@
      reporter: function
       diff --git a/docs/@vertx/unit/classes/failure.html b/docs/@vertx/unit/classes/failure.html index 27115e39e..c03f78b25 100644 --- a/docs/@vertx/unit/classes/failure.html +++ b/docs/@vertx/unit/classes/failure.html @@ -99,7 +99,7 @@

      isError

    • @@ -119,7 +119,7 @@

      message

    • @@ -139,7 +139,7 @@

      stackTrace

    • @@ -164,7 +164,7 @@

      Returns string Async

      • -
    • +
    • Completion
    • diff --git a/docs/@vertx/unit/classes/reportingoptions.html b/docs/@vertx/unit/classes/reportingoptions.html index 808a1fac7..06eb95ca1 100644 --- a/docs/@vertx/unit/classes/reportingoptions.html +++ b/docs/@vertx/unit/classes/reportingoptions.html @@ -77,38 +77,145 @@

      Index

      -

      Properties

      +

      Constructors

      +
      +
      +

      Methods

      +
    -

    Properties

    -
    - -

    reporters

    -
    reporters: ReportOptions
    - -
    -
    -

    Replace the current list of reporters with a new one.

    -
    -
    -
    param
    -

    the new reporters

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Methods

    +
    + +

    addReporter

    + +
      +
    • + +
      +
      +

      Replace the current list of reporters with a new one.

      +
      +
      +

      Parameters

      + +

      Returns ReportingOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getReporters

    + +
      +
    • + +
      +
      +

      Replace the current list of reporters with a new one.

      +
      +
      +

      Returns ReportOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setReporters

    + +
      +
    • + +
      +
      +

      Replace the current list of reporters with a new one.

      +
      +
      +

      Parameters

      + +

      Returns ReportingOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -125,7 +232,7 @@

    reporters

  • Async
    • -
  • +
  • Completion
  • @@ -142,8 +249,17 @@

    reporters

  • ReportingOptions
    • diff --git a/docs/@vertx/unit/classes/reportoptions.html b/docs/@vertx/unit/classes/reportoptions.html index 6a1f18a43..7b677627c 100644 --- a/docs/@vertx/unit/classes/reportoptions.html +++ b/docs/@vertx/unit/classes/reportoptions.html @@ -77,63 +77,171 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +
    -

    Properties

    -
    - -

    format

    -
    format: string
    - -
    -
    -

    Set the current reporter format.

    -
    -
    -
    param
    -

    the format

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently - a

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    to

    -
    to: string
    - -
    -
    -

    Set the current reporter name.

    -
    -
    -
    param
    -

    the new reporter name

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getFormat

    +
      +
    • getFormat(): string
      • +
    +
      +
    • + +
      +
      +

      Set the current reporter format.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently + a

      +
      • +
    +
    +
    + +

    getTo

    +
      +
    • getTo(): string
      • +
    +
      +
    • + +
      +
      +

      Set the current reporter name.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setFormat

    + +
      +
    • + +
      +
      +

      Set the current reporter format.

      +
      +
      +

      Parameters

      +
        +
      • +
        format: string
        +
        +

        the format

        +
        +
        • +
      +

      Returns ReportOptions

      +

      a reference to this, so the API can be used fluently + a

      +
      • +
    +
    +
    + +

    setTo

    + +
      +
    • + +
      +
      +

      Set the current reporter name.

      +
      +
      +

      Parameters

      +
        +
      • +
        to: string
        +
        +

        the new reporter name

        +
        +
        • +
      +

      Returns ReportOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -150,7 +258,7 @@

    to

  • Async
    • -
  • +
  • Completion
  • @@ -164,11 +272,20 @@

    to

  • ReportOptions
    • diff --git a/docs/@vertx/unit/classes/testcase.html b/docs/@vertx/unit/classes/testcase.html index 6d6278d49..a6c7104a2 100644 --- a/docs/@vertx/unit/classes/testcase.html +++ b/docs/@vertx/unit/classes/testcase.html @@ -97,12 +97,12 @@

    Static create

  • -

    Create a test case.

    +

    Create a test case.

    Parameters

    @@ -121,17 +121,20 @@
    testCase: function
      • @@ -158,7 +161,7 @@

      Returns Async -
    • +
    • Completion
    • diff --git a/docs/@vertx/unit/classes/testcasereport.html b/docs/@vertx/unit/classes/testcasereport.html index bbdfd89eb..e01171587 100644 --- a/docs/@vertx/unit/classes/testcasereport.html +++ b/docs/@vertx/unit/classes/testcasereport.html @@ -98,12 +98,12 @@

      endHandler

    • -

      Set a callback for completion, the specified {@code handler} is invoked when the test exec has completed.

      +

      Set a callback for completion, the specified {@code handler} is invoked when the test exec has completed.

      Parameters

      @@ -116,17 +116,20 @@
      handler: function
        • @@ -148,7 +151,7 @@

        name

      • @@ -173,7 +176,7 @@

        Returns string Async

        • -
      • +
      • Completion
      • diff --git a/docs/@vertx/unit/classes/testcompletion.html b/docs/@vertx/unit/classes/testcompletion.html index d5b78088c..5a797729f 100644 --- a/docs/@vertx/unit/classes/testcompletion.html +++ b/docs/@vertx/unit/classes/testcompletion.html @@ -68,7 +68,12 @@

        Class TestCompletion

        Hierarchy

        • - TestCompletion + Completion<void> +
            +
          • + TestCompletion +
            • +

    • @@ -79,8 +84,13 @@

    Index

    Methods

    @@ -88,22 +98,121 @@

    Methods

    Methods

    -
    +
    + +

    await

    +
      +
    • await(): void
      • +
    • await(timeoutMillis: number): void
      • +
    +
      +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes.

      +
      +

      If the current thread is interrupted, an exception will be thrown.

      +
      +

      Returns void

      +
      • +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes with a configurable timeout.

      +
      +

      If completion times out or the current thread is interrupted, an exception will be thrown.

      +
      +

      Parameters

      +
        +
      • +
        timeoutMillis: number
        +
        +

        the timeout in milliseconds

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    awaitSuccess

    +
      +
    • awaitSuccess(): void
      • +
    • awaitSuccess(timeoutMillis: number): void
      • +
    +
      +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes and succeeds.

      +
      +

      If the current thread is interrupted or the suite fails, an exception will be thrown.

      +
      +

      Returns void

      +
      • +
    • + +
      +
      +

      Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

      +
      +

      If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown.

      +
      +

      Parameters

      +
        +
      • +
        timeoutMillis: number
        +
        +

        the timeout in milliseconds

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +

    handler

    -
      +
      • handler(completionHandler: function): void
      • -

        Completion handler to receive a completion signal when this completions completes.

        +

        Completion handler to receive a completion signal when this completions completes.

        Parameters

        @@ -116,17 +225,20 @@
        completionHandler: function
          • -
          • (result: AsyncResult<void>): void
            • +
          • (res: AsyncResult<void>): void | Handler<AsyncResult<void>>

          • Parameters

            • -
              result: AsyncResult<void>
              +
              res: AsyncResult<void>
            -

            Returns void

            +

            Returns void + | + Handler<AsyncResult<void>> +

          • @@ -137,28 +249,92 @@

          Returns void

    -
    +
    + +

    isCompleted

    +
      +
    • isCompleted(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if this completion is completed

      +
      • +
    +
    +
    + +

    isFailed

    +
      +
    • isFailed(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if the this completion is completed and failed

      +
      • +
    +
    +
    + +

    isSucceeded

    +
      +
    • isSucceeded(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if this completion is completed and succeeded

      +
      • +
    +
    +

    resolve

    -
    -
    +

    put

    -
      -
    • put(key: string, value: any): Object
      • +
        +
      • put<T>(key: string, value: any): T
      • -

        Put some data in the context. +

        Put some data in the context.

        This can be used to share data between different tests and before/after phases.

        +

        Type parameters

        +
          +
        • +

          T

          +
          • +

        Parameters

        • @@ -1039,29 +1099,35 @@
          value: any
        -

        Returns Object

        +

        Returns T

        the previous object when it exists

    -
    +

    remove

    -
      -
    • remove(key: string): Object
      • +
        +
      • remove<T>(key: string): T
      • -

        Remove some data from the context.

        +

        Remove some data from the context.

        +

        Type parameters

        +
          +
        • +

          T

          +
          • +

        Parameters

        • @@ -1071,7 +1137,7 @@
          key: string
        -

        Returns Object

        +

        Returns T

        the removed object when it exists

      @@ -1086,12 +1152,12 @@

      strictAsync

    • -

      Create and returns a new async object, the returned async controls the completion of the test. +

      Create and returns a new async object, the returned async controls the completion of the test. This async operation completes when the {@link Async#countDown()} is called {@code count} times.

      If {@link Async#countDown()} is called more than {@code count} times, an {@link IllegalStateException} is thrown.

      @@ -1120,12 +1186,12 @@

      verify

    • -

      Execute the provided handler, which may contain assertions, possibly from any third-party assertion framework. +

      Execute the provided handler, which may contain assertions, possibly from any third-party assertion framework. Any {@link AssertionError} thrown will be caught (and propagated) in order to fulfill potential expected async completeness.

      @@ -1140,17 +1206,20 @@
      block: function
    -

    Properties

    -
    - -

    reporters

    -
    reporters: ReportOptions
    - -
    -
    -

    Replace the current list of reporters with a new one.

    -
    -
    -
    param
    -

    the new reporters

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns TestOptions

      +
      • +
    • + +

      Parameters

      + +

      Returns TestOptions

      +
      • +
    -
    - -

    timeout

    -
    timeout: number
    - -
    -
    -

    Set the test timeout.

    -
    -
    -
    param
    -

    the timeout value in milliseconds.

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addReporter

    + +
      +
    • + +
      +
      +

      Replace the current list of reporters with a new one.

      +
      +
      +

      Parameters

      + +

      Returns TestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    useEventLoop

    -
    useEventLoop: boolean
    - -
    -
    -

    Configure the execution to use an event loop when there is no one existing.

    -
    -
    -
    param
    -

    the even loop usage

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getReporters

    + +
      +
    • + +
      +
      +

      Replace the current list of reporters with a new one.

      +
      +
      +

      Returns ReportOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getTimeout

    +
      +
    • getTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Set the test timeout.

      +
      +
      +

      Returns number

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isUseEventLoop

    +
      +
    • isUseEventLoop(): boolean
      • +
    +
      +
    • + +
      +
      +

      Configure the execution to use an event loop when there is no one existing.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setReporters

    + +
      +
    • + +
      +
      +

      Replace the current list of reporters with a new one.

      +
      +
      +

      Parameters

      + +

      Returns TestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setTimeout

    + +
      +
    • + +
      +
      +

      Set the test timeout.

      +
      +
      +

      Parameters

      +
        +
      • +
        timeout: number
        +
        +

        the timeout value in milliseconds.

        +
        +
        • +
      +

      Returns TestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setUseEventLoop

    +
      +
    • setUseEventLoop(useEventLoop: boolean): TestOptions
      • +
    +
      +
    • + +
      +
      +

      Configure the execution to use an event loop when there is no one existing.

      +
      +
      +

      Parameters

      +
        +
      • +
        useEventLoop: boolean
        +
        +

        the even loop usage

        +
        +
        • +
      +

      Returns TestOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    @@ -173,7 +346,7 @@

    useEventLoop

  • Async
    • -
  • +
  • Completion
  • @@ -205,14 +378,29 @@

    useEventLoop

  • TestOptions
    • diff --git a/docs/@vertx/unit/classes/testresult.html b/docs/@vertx/unit/classes/testresult.html index a13636575..16339a9db 100644 --- a/docs/@vertx/unit/classes/testresult.html +++ b/docs/@vertx/unit/classes/testresult.html @@ -102,12 +102,12 @@

    beginTime

  • -

    The time at which the test began in millis.

    +

    The time at which the test began in millis.

    Returns number

    @@ -124,12 +124,12 @@

    durationTime

  • -

    How long the test lasted in millis.

    +

    How long the test lasted in millis.

    Returns number

    @@ -146,12 +146,12 @@

    failed

  • -

    Did it fail?

    +

    Did it fail?

    Returns boolean

    @@ -168,12 +168,12 @@

    failure

  • -

    An exception describing failure, null if the test succeeded.

    +

    An exception describing failure, null if the test succeeded.

    Returns Failure

    @@ -190,12 +190,12 @@

    name

  • -

    The test description, may be null if none was provided.

    +

    The test description, may be null if none was provided.

    Returns string

    @@ -212,12 +212,12 @@

    succeeded

  • -

    Did it succeed?

    +

    Did it succeed?

    Returns boolean

    @@ -239,7 +239,7 @@

    Returns boolean Async

    • -
  • +
  • Completion
  • diff --git a/docs/@vertx/unit/classes/testsuite.html b/docs/@vertx/unit/classes/testsuite.html index 48eb2e48b..c5b30a28c 100644 --- a/docs/@vertx/unit/classes/testsuite.html +++ b/docs/@vertx/unit/classes/testsuite.html @@ -108,7 +108,7 @@

    after

    -

    Set a callback executed after the tests.

    +

    Set a callback executed after the tests.

    Parameters

    @@ -121,17 +121,20 @@
    callback: function
    • +
    +

    Implements

    +
      +
    • any
      • +
    +

    Index

    @@ -81,6 +87,7 @@

    Methods

    • endHandler
    • exceptionHandler
      • +
    • fetch
    • handler
    • name
    • pause
      • @@ -102,7 +109,7 @@

      endHandler

    • Parameters

      @@ -112,17 +119,19 @@
      endHandler: function
        • -
        • (result: void): void | null | undefined
          • +
        • (res: void): void | Handler<void> | null | undefined

        • Parameters

          • -
            result: void
            +
            res: void

          Returns void + | + Handler<void> | null | @@ -148,12 +157,12 @@

          exceptionHandler

        • -

          Set an exception handler, the exception handler reports the test suite errors, it can be called mulitple +

          Set an exception handler, the exception handler reports the test suite errors, it can be called mulitple times before the test ends.

          @@ -167,17 +176,19 @@
          handler: function
            • -
            • (result: Error): void | null | undefined
              • +
            • (res: Error): void | Handler<Error> | null | undefined

            • Parameters

              • -
                result: Error
                +
                res: Error

              Returns void + | + Handler<Error> | null | @@ -194,6 +205,29 @@

              Returns + +

              fetch

              + +
                +
              • + +

                Parameters

                +
                  +
                • +
                  arg0: number
                  +
                  • +
                +

                Returns ReadStream<TestCaseReport>

                +
                • +
              +

    handler

    @@ -204,7 +238,7 @@

    handler

  • Parameters

    @@ -214,17 +248,19 @@
    handler: function

      • Parameters

        Returns void + | + Handler<TestCaseReport> | null | @@ -250,7 +286,7 @@

        name

      • @@ -270,7 +306,7 @@

        pause

      • Returns TestSuiteReport

        @@ -287,7 +323,7 @@

        resume

      • Returns TestSuiteReport

        @@ -309,7 +345,7 @@

        Returns Async

        • -
      • +
      • Completion
      • @@ -356,6 +392,9 @@

        Returns exceptionHandler

        • +
      • + fetch +
      • handler
        • diff --git a/docs/@vertx/unit/globals.html b/docs/@vertx/unit/globals.html index 363fceb59..abadba937 100644 --- a/docs/@vertx/unit/globals.html +++ b/docs/@vertx/unit/globals.html @@ -69,7 +69,7 @@

        Index

        Classes

        • Async
          • -
        • Completion
          • +
        • Completion
        • EventBusCollector
        • Failure
        • ReportOptions
          • @@ -101,7 +101,7 @@

          Classes

        • Async
          • -
        • +
        • Completion
        • diff --git a/docs/@vertx/unit/index.html b/docs/@vertx/unit/index.html index ac4d9a684..144652565 100644 --- a/docs/@vertx/unit/index.html +++ b/docs/@vertx/unit/index.html @@ -110,7 +110,7 @@
        • Async
          • -
        • +
        • Completion
        • diff --git a/docs/@vertx/vertx-mqtt/assets/js/search.js b/docs/@vertx/vertx-mqtt/assets/js/search.js index 4c4217499..701946077 100644 --- a/docs/@vertx/vertx-mqtt/assets/js/search.js +++ b/docs/@vertx/vertx-mqtt/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","256":"Interface","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"MqttAuth","url":"classes/mqttauth.html","classes":"tsd-kind-class"},{"id":1,"kind":128,"name":"MqttClientOptions","url":"classes/mqttclientoptions.html","classes":"tsd-kind-class"},{"id":2,"kind":1024,"name":"autoGeneratedClientId","url":"classes/mqttclientoptions.html#autogeneratedclientid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":3,"kind":1024,"name":"autoKeepAlive","url":"classes/mqttclientoptions.html#autokeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":4,"kind":1024,"name":"cleanSession","url":"classes/mqttclientoptions.html#cleansession","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":5,"kind":1024,"name":"clientId","url":"classes/mqttclientoptions.html#clientid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":6,"kind":1024,"name":"connectTimeout","url":"classes/mqttclientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":7,"kind":1024,"name":"crlPaths","url":"classes/mqttclientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":8,"kind":1024,"name":"crlValues","url":"classes/mqttclientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":9,"kind":1024,"name":"enabledCipherSuites","url":"classes/mqttclientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":10,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/mqttclientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":11,"kind":1024,"name":"hostnameVerificationAlgorithm","url":"classes/mqttclientoptions.html#hostnameverificationalgorithm","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":12,"kind":1024,"name":"idleTimeout","url":"classes/mqttclientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":13,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/mqttclientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":14,"kind":1024,"name":"keepAliveTimeSeconds","url":"classes/mqttclientoptions.html#keepalivetimeseconds","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":15,"kind":1024,"name":"keyStoreOptions","url":"classes/mqttclientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":16,"kind":1024,"name":"localAddress","url":"classes/mqttclientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":17,"kind":1024,"name":"logActivity","url":"classes/mqttclientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":18,"kind":1024,"name":"maxInflightQueue","url":"classes/mqttclientoptions.html#maxinflightqueue","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":19,"kind":1024,"name":"maxMessageSize","url":"classes/mqttclientoptions.html#maxmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":20,"kind":1024,"name":"metricsName","url":"classes/mqttclientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":21,"kind":1024,"name":"openSslEngineOptions","url":"classes/mqttclientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":22,"kind":1024,"name":"password","url":"classes/mqttclientoptions.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":23,"kind":1024,"name":"pemKeyCertOptions","url":"classes/mqttclientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":24,"kind":1024,"name":"pemTrustOptions","url":"classes/mqttclientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":25,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/mqttclientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":26,"kind":1024,"name":"pfxTrustOptions","url":"classes/mqttclientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":27,"kind":1024,"name":"proxyOptions","url":"classes/mqttclientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":28,"kind":1024,"name":"receiveBufferSize","url":"classes/mqttclientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":29,"kind":1024,"name":"reconnectAttempts","url":"classes/mqttclientoptions.html#reconnectattempts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":30,"kind":1024,"name":"reconnectInterval","url":"classes/mqttclientoptions.html#reconnectinterval","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":31,"kind":1024,"name":"reuseAddress","url":"classes/mqttclientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":32,"kind":1024,"name":"reusePort","url":"classes/mqttclientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":33,"kind":1024,"name":"sendBufferSize","url":"classes/mqttclientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":34,"kind":1024,"name":"soLinger","url":"classes/mqttclientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":35,"kind":1024,"name":"ssl","url":"classes/mqttclientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":36,"kind":1024,"name":"tcpCork","url":"classes/mqttclientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":37,"kind":1024,"name":"tcpFastOpen","url":"classes/mqttclientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":38,"kind":1024,"name":"tcpKeepAlive","url":"classes/mqttclientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":39,"kind":1024,"name":"tcpNoDelay","url":"classes/mqttclientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":40,"kind":1024,"name":"tcpQuickAck","url":"classes/mqttclientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":41,"kind":1024,"name":"trafficClass","url":"classes/mqttclientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":42,"kind":1024,"name":"trustAll","url":"classes/mqttclientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":43,"kind":1024,"name":"trustStoreOptions","url":"classes/mqttclientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":44,"kind":1024,"name":"useAlpn","url":"classes/mqttclientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":45,"kind":1024,"name":"usePooledBuffers","url":"classes/mqttclientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":46,"kind":1024,"name":"username","url":"classes/mqttclientoptions.html#username","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":47,"kind":1024,"name":"willFlag","url":"classes/mqttclientoptions.html#willflag","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":48,"kind":1024,"name":"willMessage","url":"classes/mqttclientoptions.html#willmessage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":49,"kind":1024,"name":"willQoS","url":"classes/mqttclientoptions.html#willqos","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":50,"kind":1024,"name":"willRetain","url":"classes/mqttclientoptions.html#willretain","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":51,"kind":1024,"name":"willTopic","url":"classes/mqttclientoptions.html#willtopic","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":52,"kind":128,"name":"MqttServerOptions","url":"classes/mqttserveroptions.html","classes":"tsd-kind-class"},{"id":53,"kind":1024,"name":"acceptBacklog","url":"classes/mqttserveroptions.html#acceptbacklog","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":54,"kind":1024,"name":"autoClientId","url":"classes/mqttserveroptions.html#autoclientid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":55,"kind":1024,"name":"clientAuth","url":"classes/mqttserveroptions.html#clientauth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":56,"kind":1024,"name":"clientAuthRequired","url":"classes/mqttserveroptions.html#clientauthrequired","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":57,"kind":1024,"name":"crlPaths","url":"classes/mqttserveroptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":58,"kind":1024,"name":"crlValues","url":"classes/mqttserveroptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":59,"kind":1024,"name":"enabledCipherSuites","url":"classes/mqttserveroptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":60,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/mqttserveroptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":61,"kind":1024,"name":"host","url":"classes/mqttserveroptions.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":62,"kind":1024,"name":"idleTimeout","url":"classes/mqttserveroptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":63,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/mqttserveroptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":64,"kind":1024,"name":"keyStoreOptions","url":"classes/mqttserveroptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":65,"kind":1024,"name":"logActivity","url":"classes/mqttserveroptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":66,"kind":1024,"name":"maxMessageSize","url":"classes/mqttserveroptions.html#maxmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":67,"kind":1024,"name":"openSslEngineOptions","url":"classes/mqttserveroptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":68,"kind":1024,"name":"pemKeyCertOptions","url":"classes/mqttserveroptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":69,"kind":1024,"name":"pemTrustOptions","url":"classes/mqttserveroptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":70,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/mqttserveroptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":71,"kind":1024,"name":"pfxTrustOptions","url":"classes/mqttserveroptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":72,"kind":1024,"name":"port","url":"classes/mqttserveroptions.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":73,"kind":1024,"name":"receiveBufferSize","url":"classes/mqttserveroptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":74,"kind":1024,"name":"reuseAddress","url":"classes/mqttserveroptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":75,"kind":1024,"name":"reusePort","url":"classes/mqttserveroptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":76,"kind":1024,"name":"sendBufferSize","url":"classes/mqttserveroptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":77,"kind":1024,"name":"sni","url":"classes/mqttserveroptions.html#sni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":78,"kind":1024,"name":"soLinger","url":"classes/mqttserveroptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":79,"kind":1024,"name":"ssl","url":"classes/mqttserveroptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":80,"kind":1024,"name":"tcpCork","url":"classes/mqttserveroptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":81,"kind":1024,"name":"tcpFastOpen","url":"classes/mqttserveroptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":82,"kind":1024,"name":"tcpKeepAlive","url":"classes/mqttserveroptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":83,"kind":1024,"name":"tcpNoDelay","url":"classes/mqttserveroptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":84,"kind":1024,"name":"tcpQuickAck","url":"classes/mqttserveroptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":85,"kind":1024,"name":"timeoutOnConnect","url":"classes/mqttserveroptions.html#timeoutonconnect","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":86,"kind":1024,"name":"trafficClass","url":"classes/mqttserveroptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":87,"kind":1024,"name":"trustStoreOptions","url":"classes/mqttserveroptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":88,"kind":1024,"name":"useAlpn","url":"classes/mqttserveroptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":89,"kind":1024,"name":"usePooledBuffers","url":"classes/mqttserveroptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":90,"kind":128,"name":"MqttWill","url":"classes/mqttwill.html","classes":"tsd-kind-class"},{"id":91,"kind":128,"name":"MqttClient","url":"classes/mqttclient.html","classes":"tsd-kind-class"},{"id":92,"kind":2048,"name":"create","url":"classes/mqttclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MqttClient"},{"id":93,"kind":2048,"name":"connect","url":"classes/mqttclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":94,"kind":2048,"name":"disconnect","url":"classes/mqttclient.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":95,"kind":2048,"name":"publish","url":"classes/mqttclient.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":96,"kind":2048,"name":"publishCompletionHandler","url":"classes/mqttclient.html#publishcompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":97,"kind":2048,"name":"publishHandler","url":"classes/mqttclient.html#publishhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":98,"kind":2048,"name":"subscribeCompletionHandler","url":"classes/mqttclient.html#subscribecompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":99,"kind":2048,"name":"subscribe","url":"classes/mqttclient.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":100,"kind":2048,"name":"unsubscribeCompletionHandler","url":"classes/mqttclient.html#unsubscribecompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":101,"kind":2048,"name":"unsubscribe","url":"classes/mqttclient.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":102,"kind":2048,"name":"pingResponseHandler","url":"classes/mqttclient.html#pingresponsehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":103,"kind":2048,"name":"exceptionHandler","url":"classes/mqttclient.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":104,"kind":2048,"name":"closeHandler","url":"classes/mqttclient.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":105,"kind":2048,"name":"ping","url":"classes/mqttclient.html#ping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":106,"kind":2048,"name":"clientId","url":"classes/mqttclient.html#clientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":107,"kind":2048,"name":"isConnected","url":"classes/mqttclient.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":108,"kind":128,"name":"MqttConnAckMessage","url":"classes/mqttconnackmessage.html","classes":"tsd-kind-class"},{"id":109,"kind":2048,"name":"create","url":"classes/mqttconnackmessage.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MqttConnAckMessage"},{"id":110,"kind":2048,"name":"code","url":"classes/mqttconnackmessage.html#code","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttConnAckMessage"},{"id":111,"kind":2048,"name":"isSessionPresent","url":"classes/mqttconnackmessage.html#issessionpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttConnAckMessage"},{"id":112,"kind":128,"name":"MqttEndpoint","url":"classes/mqttendpoint.html","classes":"tsd-kind-class"},{"id":113,"kind":2048,"name":"close","url":"classes/mqttendpoint.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":114,"kind":2048,"name":"remoteAddress","url":"classes/mqttendpoint.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":115,"kind":2048,"name":"localAddress","url":"classes/mqttendpoint.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":116,"kind":2048,"name":"clientIdentifier","url":"classes/mqttendpoint.html#clientidentifier","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":117,"kind":2048,"name":"auth","url":"classes/mqttendpoint.html#auth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":118,"kind":2048,"name":"will","url":"classes/mqttendpoint.html#will","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":119,"kind":2048,"name":"protocolVersion","url":"classes/mqttendpoint.html#protocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":120,"kind":2048,"name":"protocolName","url":"classes/mqttendpoint.html#protocolname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":121,"kind":2048,"name":"isCleanSession","url":"classes/mqttendpoint.html#iscleansession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":122,"kind":2048,"name":"keepAliveTimeSeconds","url":"classes/mqttendpoint.html#keepalivetimeseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":123,"kind":2048,"name":"lastMessageId","url":"classes/mqttendpoint.html#lastmessageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":124,"kind":2048,"name":"subscriptionAutoAck","url":"classes/mqttendpoint.html#subscriptionautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":125,"kind":2048,"name":"isSubscriptionAutoAck","url":"classes/mqttendpoint.html#issubscriptionautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":126,"kind":2048,"name":"publishAutoAck","url":"classes/mqttendpoint.html#publishautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":127,"kind":2048,"name":"isPublishAutoAck","url":"classes/mqttendpoint.html#ispublishautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":128,"kind":2048,"name":"autoKeepAlive","url":"classes/mqttendpoint.html#autokeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":129,"kind":2048,"name":"isAutoKeepAlive","url":"classes/mqttendpoint.html#isautokeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":130,"kind":2048,"name":"isConnected","url":"classes/mqttendpoint.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":131,"kind":2048,"name":"setClientIdentifier","url":"classes/mqttendpoint.html#setclientidentifier","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":132,"kind":2048,"name":"disconnectHandler","url":"classes/mqttendpoint.html#disconnecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":133,"kind":2048,"name":"subscribeHandler","url":"classes/mqttendpoint.html#subscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":134,"kind":2048,"name":"unsubscribeHandler","url":"classes/mqttendpoint.html#unsubscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":135,"kind":2048,"name":"publishHandler","url":"classes/mqttendpoint.html#publishhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":136,"kind":2048,"name":"publishAcknowledgeHandler","url":"classes/mqttendpoint.html#publishacknowledgehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":137,"kind":2048,"name":"publishReceivedHandler","url":"classes/mqttendpoint.html#publishreceivedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":138,"kind":2048,"name":"publishReleaseHandler","url":"classes/mqttendpoint.html#publishreleasehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":139,"kind":2048,"name":"publishCompletionHandler","url":"classes/mqttendpoint.html#publishcompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":140,"kind":2048,"name":"pingHandler","url":"classes/mqttendpoint.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":141,"kind":2048,"name":"closeHandler","url":"classes/mqttendpoint.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":142,"kind":2048,"name":"exceptionHandler","url":"classes/mqttendpoint.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":143,"kind":2048,"name":"accept","url":"classes/mqttendpoint.html#accept","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":144,"kind":2048,"name":"reject","url":"classes/mqttendpoint.html#reject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":145,"kind":2048,"name":"subscribeAcknowledge","url":"classes/mqttendpoint.html#subscribeacknowledge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":146,"kind":2048,"name":"unsubscribeAcknowledge","url":"classes/mqttendpoint.html#unsubscribeacknowledge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":147,"kind":2048,"name":"publishAcknowledge","url":"classes/mqttendpoint.html#publishacknowledge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":148,"kind":2048,"name":"publishReceived","url":"classes/mqttendpoint.html#publishreceived","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":149,"kind":2048,"name":"publishRelease","url":"classes/mqttendpoint.html#publishrelease","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":150,"kind":2048,"name":"publishComplete","url":"classes/mqttendpoint.html#publishcomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":151,"kind":2048,"name":"publish","url":"classes/mqttendpoint.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":152,"kind":2048,"name":"pong","url":"classes/mqttendpoint.html#pong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":153,"kind":256,"name":"MqttMessage","url":"interfaces/mqttmessage.html","classes":"tsd-kind-interface"},{"id":154,"kind":2048,"name":"messageId","url":"interfaces/mqttmessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"MqttMessage"},{"id":155,"kind":128,"name":"MqttPublishMessage","url":"classes/mqttpublishmessage.html","classes":"tsd-kind-class"},{"id":156,"kind":2048,"name":"messageId","url":"classes/mqttpublishmessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":157,"kind":2048,"name":"qosLevel","url":"classes/mqttpublishmessage.html#qoslevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":158,"kind":2048,"name":"isDup","url":"classes/mqttpublishmessage.html#isdup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":159,"kind":2048,"name":"isRetain","url":"classes/mqttpublishmessage.html#isretain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":160,"kind":2048,"name":"topicName","url":"classes/mqttpublishmessage.html#topicname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":161,"kind":2048,"name":"payload","url":"classes/mqttpublishmessage.html#payload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":162,"kind":128,"name":"MqttServer","url":"classes/mqttserver.html","classes":"tsd-kind-class"},{"id":163,"kind":2048,"name":"create","url":"classes/mqttserver.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MqttServer"},{"id":164,"kind":2048,"name":"listen","url":"classes/mqttserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":165,"kind":2048,"name":"endpointHandler","url":"classes/mqttserver.html#endpointhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":166,"kind":2048,"name":"exceptionHandler","url":"classes/mqttserver.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":167,"kind":2048,"name":"actualPort","url":"classes/mqttserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":168,"kind":2048,"name":"close","url":"classes/mqttserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":169,"kind":128,"name":"MqttSubAckMessage","url":"classes/mqttsubackmessage.html","classes":"tsd-kind-class"},{"id":170,"kind":2048,"name":"messageId","url":"classes/mqttsubackmessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubAckMessage"},{"id":171,"kind":2048,"name":"grantedQoSLevels","url":"classes/mqttsubackmessage.html#grantedqoslevels","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubAckMessage"},{"id":172,"kind":128,"name":"MqttSubscribeMessage","url":"classes/mqttsubscribemessage.html","classes":"tsd-kind-class"},{"id":173,"kind":2048,"name":"messageId","url":"classes/mqttsubscribemessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubscribeMessage"},{"id":174,"kind":2048,"name":"topicSubscriptions","url":"classes/mqttsubscribemessage.html#topicsubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubscribeMessage"},{"id":175,"kind":128,"name":"MqttTopicSubscription","url":"classes/mqtttopicsubscription.html","classes":"tsd-kind-class"},{"id":176,"kind":2048,"name":"topicName","url":"classes/mqtttopicsubscription.html#topicname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttTopicSubscription"},{"id":177,"kind":2048,"name":"qualityOfService","url":"classes/mqtttopicsubscription.html#qualityofservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttTopicSubscription"},{"id":178,"kind":128,"name":"MqttUnsubscribeMessage","url":"classes/mqttunsubscribemessage.html","classes":"tsd-kind-class"},{"id":179,"kind":2048,"name":"messageId","url":"classes/mqttunsubscribemessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttUnsubscribeMessage"},{"id":180,"kind":2048,"name":"topics","url":"classes/mqttunsubscribemessage.html#topics","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttUnsubscribeMessage"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"MqttAuth","url":"classes/mqttauth.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/mqttauth.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MqttAuth"},{"id":2,"kind":2048,"name":"getPassword","url":"classes/mqttauth.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttAuth"},{"id":3,"kind":2048,"name":"getUsername","url":"classes/mqttauth.html#getusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttAuth"},{"id":4,"kind":128,"name":"MqttClientOptions","url":"classes/mqttclientoptions.html","classes":"tsd-kind-class"},{"id":5,"kind":512,"name":"constructor","url":"classes/mqttclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":6,"kind":2048,"name":"isAutoGeneratedClientId","url":"classes/mqttclientoptions.html#isautogeneratedclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":7,"kind":2048,"name":"setAutoGeneratedClientId","url":"classes/mqttclientoptions.html#setautogeneratedclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":8,"kind":2048,"name":"isAutoKeepAlive","url":"classes/mqttclientoptions.html#isautokeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":9,"kind":2048,"name":"setAutoKeepAlive","url":"classes/mqttclientoptions.html#setautokeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":10,"kind":2048,"name":"isCleanSession","url":"classes/mqttclientoptions.html#iscleansession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":11,"kind":2048,"name":"setCleanSession","url":"classes/mqttclientoptions.html#setcleansession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":12,"kind":2048,"name":"getClientId","url":"classes/mqttclientoptions.html#getclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":13,"kind":2048,"name":"setClientId","url":"classes/mqttclientoptions.html#setclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":14,"kind":2048,"name":"getConnectTimeout","url":"classes/mqttclientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":15,"kind":2048,"name":"setConnectTimeout","url":"classes/mqttclientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":16,"kind":2048,"name":"getCrlPaths","url":"classes/mqttclientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":17,"kind":2048,"name":"addCrlPath","url":"classes/mqttclientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":18,"kind":2048,"name":"getCrlValues","url":"classes/mqttclientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":19,"kind":2048,"name":"addCrlValue","url":"classes/mqttclientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":20,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/mqttclientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":21,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/mqttclientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":22,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/mqttclientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":23,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/mqttclientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":24,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/mqttclientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":25,"kind":2048,"name":"getHostnameVerificationAlgorithm","url":"classes/mqttclientoptions.html#gethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":26,"kind":2048,"name":"setHostnameVerificationAlgorithm","url":"classes/mqttclientoptions.html#sethostnameverificationalgorithm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":27,"kind":2048,"name":"getIdleTimeout","url":"classes/mqttclientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":28,"kind":2048,"name":"setIdleTimeout","url":"classes/mqttclientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":29,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/mqttclientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":30,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/mqttclientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":31,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/mqttclientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":32,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/mqttclientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":33,"kind":2048,"name":"getKeepAliveTimeSeconds","url":"classes/mqttclientoptions.html#getkeepalivetimeseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":34,"kind":2048,"name":"setKeepAliveTimeSeconds","url":"classes/mqttclientoptions.html#setkeepalivetimeseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":35,"kind":2048,"name":"getKeyStoreOptions","url":"classes/mqttclientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":36,"kind":2048,"name":"setKeyStoreOptions","url":"classes/mqttclientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":37,"kind":2048,"name":"getLocalAddress","url":"classes/mqttclientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":38,"kind":2048,"name":"setLocalAddress","url":"classes/mqttclientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":39,"kind":2048,"name":"getLogActivity","url":"classes/mqttclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":40,"kind":2048,"name":"setLogActivity","url":"classes/mqttclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":41,"kind":2048,"name":"getMaxInflightQueue","url":"classes/mqttclientoptions.html#getmaxinflightqueue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":42,"kind":2048,"name":"setMaxInflightQueue","url":"classes/mqttclientoptions.html#setmaxinflightqueue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":43,"kind":2048,"name":"getMaxMessageSize","url":"classes/mqttclientoptions.html#getmaxmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":44,"kind":2048,"name":"setMaxMessageSize","url":"classes/mqttclientoptions.html#setmaxmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":45,"kind":2048,"name":"getMetricsName","url":"classes/mqttclientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":46,"kind":2048,"name":"setMetricsName","url":"classes/mqttclientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":47,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/mqttclientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":48,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/mqttclientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":49,"kind":2048,"name":"getPassword","url":"classes/mqttclientoptions.html#getpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":50,"kind":2048,"name":"setPassword","url":"classes/mqttclientoptions.html#setpassword","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":51,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/mqttclientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":52,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/mqttclientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":53,"kind":2048,"name":"getPemTrustOptions","url":"classes/mqttclientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":54,"kind":2048,"name":"setPemTrustOptions","url":"classes/mqttclientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":55,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/mqttclientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":56,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/mqttclientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":57,"kind":2048,"name":"getPfxTrustOptions","url":"classes/mqttclientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":58,"kind":2048,"name":"setPfxTrustOptions","url":"classes/mqttclientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":59,"kind":2048,"name":"getProxyOptions","url":"classes/mqttclientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":60,"kind":2048,"name":"setProxyOptions","url":"classes/mqttclientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":61,"kind":2048,"name":"getReceiveBufferSize","url":"classes/mqttclientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":62,"kind":2048,"name":"setReceiveBufferSize","url":"classes/mqttclientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":63,"kind":2048,"name":"getReconnectAttempts","url":"classes/mqttclientoptions.html#getreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":64,"kind":2048,"name":"setReconnectAttempts","url":"classes/mqttclientoptions.html#setreconnectattempts","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":65,"kind":2048,"name":"getReconnectInterval","url":"classes/mqttclientoptions.html#getreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":66,"kind":2048,"name":"setReconnectInterval","url":"classes/mqttclientoptions.html#setreconnectinterval","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":67,"kind":2048,"name":"isReuseAddress","url":"classes/mqttclientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":68,"kind":2048,"name":"setReuseAddress","url":"classes/mqttclientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":69,"kind":2048,"name":"isReusePort","url":"classes/mqttclientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":70,"kind":2048,"name":"setReusePort","url":"classes/mqttclientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":71,"kind":2048,"name":"getSendBufferSize","url":"classes/mqttclientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":72,"kind":2048,"name":"setSendBufferSize","url":"classes/mqttclientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":73,"kind":2048,"name":"getSoLinger","url":"classes/mqttclientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":74,"kind":2048,"name":"setSoLinger","url":"classes/mqttclientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":75,"kind":2048,"name":"isSsl","url":"classes/mqttclientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":76,"kind":2048,"name":"setSsl","url":"classes/mqttclientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":77,"kind":2048,"name":"isTcpCork","url":"classes/mqttclientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":78,"kind":2048,"name":"setTcpCork","url":"classes/mqttclientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":79,"kind":2048,"name":"isTcpFastOpen","url":"classes/mqttclientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":80,"kind":2048,"name":"setTcpFastOpen","url":"classes/mqttclientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":81,"kind":2048,"name":"isTcpKeepAlive","url":"classes/mqttclientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":82,"kind":2048,"name":"setTcpKeepAlive","url":"classes/mqttclientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":83,"kind":2048,"name":"isTcpNoDelay","url":"classes/mqttclientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":84,"kind":2048,"name":"setTcpNoDelay","url":"classes/mqttclientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":85,"kind":2048,"name":"isTcpQuickAck","url":"classes/mqttclientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":86,"kind":2048,"name":"setTcpQuickAck","url":"classes/mqttclientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":87,"kind":2048,"name":"getTrafficClass","url":"classes/mqttclientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":88,"kind":2048,"name":"setTrafficClass","url":"classes/mqttclientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":89,"kind":2048,"name":"isTrustAll","url":"classes/mqttclientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":90,"kind":2048,"name":"setTrustAll","url":"classes/mqttclientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":91,"kind":2048,"name":"getTrustStoreOptions","url":"classes/mqttclientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":92,"kind":2048,"name":"setTrustStoreOptions","url":"classes/mqttclientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":93,"kind":2048,"name":"isUseAlpn","url":"classes/mqttclientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":94,"kind":2048,"name":"setUseAlpn","url":"classes/mqttclientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":95,"kind":2048,"name":"isUsePooledBuffers","url":"classes/mqttclientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":96,"kind":2048,"name":"setUsePooledBuffers","url":"classes/mqttclientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":97,"kind":2048,"name":"getUsername","url":"classes/mqttclientoptions.html#getusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":98,"kind":2048,"name":"setUsername","url":"classes/mqttclientoptions.html#setusername","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":99,"kind":2048,"name":"isWillFlag","url":"classes/mqttclientoptions.html#iswillflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":100,"kind":2048,"name":"setWillFlag","url":"classes/mqttclientoptions.html#setwillflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":101,"kind":2048,"name":"getWillMessage","url":"classes/mqttclientoptions.html#getwillmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":102,"kind":2048,"name":"setWillMessage","url":"classes/mqttclientoptions.html#setwillmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":103,"kind":2048,"name":"getWillQoS","url":"classes/mqttclientoptions.html#getwillqos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":104,"kind":2048,"name":"setWillQoS","url":"classes/mqttclientoptions.html#setwillqos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":105,"kind":2048,"name":"isWillRetain","url":"classes/mqttclientoptions.html#iswillretain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":106,"kind":2048,"name":"setWillRetain","url":"classes/mqttclientoptions.html#setwillretain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":107,"kind":2048,"name":"getWillTopic","url":"classes/mqttclientoptions.html#getwilltopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":108,"kind":2048,"name":"setWillTopic","url":"classes/mqttclientoptions.html#setwilltopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClientOptions"},{"id":109,"kind":128,"name":"MqttServerOptions","url":"classes/mqttserveroptions.html","classes":"tsd-kind-class"},{"id":110,"kind":512,"name":"constructor","url":"classes/mqttserveroptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":111,"kind":2048,"name":"getAcceptBacklog","url":"classes/mqttserveroptions.html#getacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":112,"kind":2048,"name":"setAcceptBacklog","url":"classes/mqttserveroptions.html#setacceptbacklog","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":113,"kind":2048,"name":"isAutoClientId","url":"classes/mqttserveroptions.html#isautoclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":114,"kind":2048,"name":"setAutoClientId","url":"classes/mqttserveroptions.html#setautoclientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":115,"kind":2048,"name":"getClientAuth","url":"classes/mqttserveroptions.html#getclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":116,"kind":2048,"name":"setClientAuth","url":"classes/mqttserveroptions.html#setclientauth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":117,"kind":2048,"name":"isClientAuthRequired","url":"classes/mqttserveroptions.html#isclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":118,"kind":2048,"name":"setClientAuthRequired","url":"classes/mqttserveroptions.html#setclientauthrequired","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":119,"kind":2048,"name":"getCrlPaths","url":"classes/mqttserveroptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":120,"kind":2048,"name":"addCrlPath","url":"classes/mqttserveroptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":121,"kind":2048,"name":"getCrlValues","url":"classes/mqttserveroptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":122,"kind":2048,"name":"addCrlValue","url":"classes/mqttserveroptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":123,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/mqttserveroptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":124,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/mqttserveroptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":125,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/mqttserveroptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":126,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/mqttserveroptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":127,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/mqttserveroptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":128,"kind":2048,"name":"getHost","url":"classes/mqttserveroptions.html#gethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":129,"kind":2048,"name":"setHost","url":"classes/mqttserveroptions.html#sethost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":130,"kind":2048,"name":"getIdleTimeout","url":"classes/mqttserveroptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":131,"kind":2048,"name":"setIdleTimeout","url":"classes/mqttserveroptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":132,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/mqttserveroptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":133,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/mqttserveroptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":134,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/mqttserveroptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":135,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/mqttserveroptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":136,"kind":2048,"name":"getKeyStoreOptions","url":"classes/mqttserveroptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":137,"kind":2048,"name":"setKeyStoreOptions","url":"classes/mqttserveroptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":138,"kind":2048,"name":"getLogActivity","url":"classes/mqttserveroptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":139,"kind":2048,"name":"setLogActivity","url":"classes/mqttserveroptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":140,"kind":2048,"name":"getMaxMessageSize","url":"classes/mqttserveroptions.html#getmaxmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":141,"kind":2048,"name":"setMaxMessageSize","url":"classes/mqttserveroptions.html#setmaxmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":142,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/mqttserveroptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":143,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/mqttserveroptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":144,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/mqttserveroptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":145,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/mqttserveroptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":146,"kind":2048,"name":"getPemTrustOptions","url":"classes/mqttserveroptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":147,"kind":2048,"name":"setPemTrustOptions","url":"classes/mqttserveroptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":148,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/mqttserveroptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":149,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/mqttserveroptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":150,"kind":2048,"name":"getPfxTrustOptions","url":"classes/mqttserveroptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":151,"kind":2048,"name":"setPfxTrustOptions","url":"classes/mqttserveroptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":152,"kind":2048,"name":"getPort","url":"classes/mqttserveroptions.html#getport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":153,"kind":2048,"name":"setPort","url":"classes/mqttserveroptions.html#setport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":154,"kind":2048,"name":"getReceiveBufferSize","url":"classes/mqttserveroptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":155,"kind":2048,"name":"setReceiveBufferSize","url":"classes/mqttserveroptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":156,"kind":2048,"name":"isReuseAddress","url":"classes/mqttserveroptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":157,"kind":2048,"name":"setReuseAddress","url":"classes/mqttserveroptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":158,"kind":2048,"name":"isReusePort","url":"classes/mqttserveroptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":159,"kind":2048,"name":"setReusePort","url":"classes/mqttserveroptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":160,"kind":2048,"name":"getSendBufferSize","url":"classes/mqttserveroptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":161,"kind":2048,"name":"setSendBufferSize","url":"classes/mqttserveroptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":162,"kind":2048,"name":"isSni","url":"classes/mqttserveroptions.html#issni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":163,"kind":2048,"name":"setSni","url":"classes/mqttserveroptions.html#setsni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":164,"kind":2048,"name":"getSoLinger","url":"classes/mqttserveroptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":165,"kind":2048,"name":"setSoLinger","url":"classes/mqttserveroptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":166,"kind":2048,"name":"isSsl","url":"classes/mqttserveroptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":167,"kind":2048,"name":"setSsl","url":"classes/mqttserveroptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":168,"kind":2048,"name":"isTcpCork","url":"classes/mqttserveroptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":169,"kind":2048,"name":"setTcpCork","url":"classes/mqttserveroptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":170,"kind":2048,"name":"isTcpFastOpen","url":"classes/mqttserveroptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":171,"kind":2048,"name":"setTcpFastOpen","url":"classes/mqttserveroptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":172,"kind":2048,"name":"isTcpKeepAlive","url":"classes/mqttserveroptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":173,"kind":2048,"name":"setTcpKeepAlive","url":"classes/mqttserveroptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":174,"kind":2048,"name":"isTcpNoDelay","url":"classes/mqttserveroptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":175,"kind":2048,"name":"setTcpNoDelay","url":"classes/mqttserveroptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":176,"kind":2048,"name":"isTcpQuickAck","url":"classes/mqttserveroptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":177,"kind":2048,"name":"setTcpQuickAck","url":"classes/mqttserveroptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":178,"kind":2048,"name":"timeoutOnConnect","url":"classes/mqttserveroptions.html#timeoutonconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":179,"kind":2048,"name":"setTimeoutOnConnect","url":"classes/mqttserveroptions.html#settimeoutonconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":180,"kind":2048,"name":"getTrafficClass","url":"classes/mqttserveroptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":181,"kind":2048,"name":"setTrafficClass","url":"classes/mqttserveroptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":182,"kind":2048,"name":"getTrustStoreOptions","url":"classes/mqttserveroptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":183,"kind":2048,"name":"setTrustStoreOptions","url":"classes/mqttserveroptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":184,"kind":2048,"name":"isUseAlpn","url":"classes/mqttserveroptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":185,"kind":2048,"name":"setUseAlpn","url":"classes/mqttserveroptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":186,"kind":2048,"name":"isUsePooledBuffers","url":"classes/mqttserveroptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":187,"kind":2048,"name":"setUsePooledBuffers","url":"classes/mqttserveroptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServerOptions"},{"id":188,"kind":128,"name":"MqttWill","url":"classes/mqttwill.html","classes":"tsd-kind-class"},{"id":189,"kind":512,"name":"constructor","url":"classes/mqttwill.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"MqttWill"},{"id":190,"kind":2048,"name":"isWillFlag","url":"classes/mqttwill.html#iswillflag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttWill"},{"id":191,"kind":2048,"name":"getWillMessage","url":"classes/mqttwill.html#getwillmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttWill"},{"id":192,"kind":2048,"name":"getWillQos","url":"classes/mqttwill.html#getwillqos","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttWill"},{"id":193,"kind":2048,"name":"isWillRetain","url":"classes/mqttwill.html#iswillretain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttWill"},{"id":194,"kind":2048,"name":"getWillTopic","url":"classes/mqttwill.html#getwilltopic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttWill"},{"id":195,"kind":128,"name":"MqttClient","url":"classes/mqttclient.html","classes":"tsd-kind-class"},{"id":196,"kind":2048,"name":"create","url":"classes/mqttclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MqttClient"},{"id":197,"kind":2048,"name":"connect","url":"classes/mqttclient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":198,"kind":2048,"name":"disconnect","url":"classes/mqttclient.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":199,"kind":2048,"name":"publish","url":"classes/mqttclient.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":200,"kind":2048,"name":"publishCompletionHandler","url":"classes/mqttclient.html#publishcompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":201,"kind":2048,"name":"publishHandler","url":"classes/mqttclient.html#publishhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":202,"kind":2048,"name":"subscribeCompletionHandler","url":"classes/mqttclient.html#subscribecompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":203,"kind":2048,"name":"subscribe","url":"classes/mqttclient.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":204,"kind":2048,"name":"unsubscribeCompletionHandler","url":"classes/mqttclient.html#unsubscribecompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":205,"kind":2048,"name":"unsubscribe","url":"classes/mqttclient.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":206,"kind":2048,"name":"pingResponseHandler","url":"classes/mqttclient.html#pingresponsehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":207,"kind":2048,"name":"exceptionHandler","url":"classes/mqttclient.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":208,"kind":2048,"name":"closeHandler","url":"classes/mqttclient.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":209,"kind":2048,"name":"ping","url":"classes/mqttclient.html#ping","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":210,"kind":2048,"name":"clientId","url":"classes/mqttclient.html#clientid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":211,"kind":2048,"name":"isConnected","url":"classes/mqttclient.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttClient"},{"id":212,"kind":128,"name":"MqttConnAckMessage","url":"classes/mqttconnackmessage.html","classes":"tsd-kind-class"},{"id":213,"kind":2048,"name":"create","url":"classes/mqttconnackmessage.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MqttConnAckMessage"},{"id":214,"kind":2048,"name":"code","url":"classes/mqttconnackmessage.html#code","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttConnAckMessage"},{"id":215,"kind":2048,"name":"isSessionPresent","url":"classes/mqttconnackmessage.html#issessionpresent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttConnAckMessage"},{"id":216,"kind":128,"name":"MqttEndpoint","url":"classes/mqttendpoint.html","classes":"tsd-kind-class"},{"id":217,"kind":2048,"name":"close","url":"classes/mqttendpoint.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":218,"kind":2048,"name":"remoteAddress","url":"classes/mqttendpoint.html#remoteaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":219,"kind":2048,"name":"localAddress","url":"classes/mqttendpoint.html#localaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":220,"kind":2048,"name":"isSsl","url":"classes/mqttendpoint.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":221,"kind":2048,"name":"clientIdentifier","url":"classes/mqttendpoint.html#clientidentifier","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":222,"kind":2048,"name":"auth","url":"classes/mqttendpoint.html#auth","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":223,"kind":2048,"name":"will","url":"classes/mqttendpoint.html#will","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":224,"kind":2048,"name":"protocolVersion","url":"classes/mqttendpoint.html#protocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":225,"kind":2048,"name":"protocolName","url":"classes/mqttendpoint.html#protocolname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":226,"kind":2048,"name":"isCleanSession","url":"classes/mqttendpoint.html#iscleansession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":227,"kind":2048,"name":"keepAliveTimeSeconds","url":"classes/mqttendpoint.html#keepalivetimeseconds","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":228,"kind":2048,"name":"lastMessageId","url":"classes/mqttendpoint.html#lastmessageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":229,"kind":2048,"name":"subscriptionAutoAck","url":"classes/mqttendpoint.html#subscriptionautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":230,"kind":2048,"name":"isSubscriptionAutoAck","url":"classes/mqttendpoint.html#issubscriptionautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":231,"kind":2048,"name":"publishAutoAck","url":"classes/mqttendpoint.html#publishautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":232,"kind":2048,"name":"isPublishAutoAck","url":"classes/mqttendpoint.html#ispublishautoack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":233,"kind":2048,"name":"autoKeepAlive","url":"classes/mqttendpoint.html#autokeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":234,"kind":2048,"name":"isAutoKeepAlive","url":"classes/mqttendpoint.html#isautokeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":235,"kind":2048,"name":"isConnected","url":"classes/mqttendpoint.html#isconnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":236,"kind":2048,"name":"setClientIdentifier","url":"classes/mqttendpoint.html#setclientidentifier","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":237,"kind":2048,"name":"disconnectHandler","url":"classes/mqttendpoint.html#disconnecthandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":238,"kind":2048,"name":"subscribeHandler","url":"classes/mqttendpoint.html#subscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":239,"kind":2048,"name":"unsubscribeHandler","url":"classes/mqttendpoint.html#unsubscribehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":240,"kind":2048,"name":"publishHandler","url":"classes/mqttendpoint.html#publishhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":241,"kind":2048,"name":"publishAcknowledgeHandler","url":"classes/mqttendpoint.html#publishacknowledgehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":242,"kind":2048,"name":"publishReceivedHandler","url":"classes/mqttendpoint.html#publishreceivedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":243,"kind":2048,"name":"publishReleaseHandler","url":"classes/mqttendpoint.html#publishreleasehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":244,"kind":2048,"name":"publishCompletionHandler","url":"classes/mqttendpoint.html#publishcompletionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":245,"kind":2048,"name":"pingHandler","url":"classes/mqttendpoint.html#pinghandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":246,"kind":2048,"name":"closeHandler","url":"classes/mqttendpoint.html#closehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":247,"kind":2048,"name":"exceptionHandler","url":"classes/mqttendpoint.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":248,"kind":2048,"name":"accept","url":"classes/mqttendpoint.html#accept","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":249,"kind":2048,"name":"reject","url":"classes/mqttendpoint.html#reject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":250,"kind":2048,"name":"subscribeAcknowledge","url":"classes/mqttendpoint.html#subscribeacknowledge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":251,"kind":2048,"name":"unsubscribeAcknowledge","url":"classes/mqttendpoint.html#unsubscribeacknowledge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":252,"kind":2048,"name":"publishAcknowledge","url":"classes/mqttendpoint.html#publishacknowledge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":253,"kind":2048,"name":"publishReceived","url":"classes/mqttendpoint.html#publishreceived","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":254,"kind":2048,"name":"publishRelease","url":"classes/mqttendpoint.html#publishrelease","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":255,"kind":2048,"name":"publishComplete","url":"classes/mqttendpoint.html#publishcomplete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":256,"kind":2048,"name":"publish","url":"classes/mqttendpoint.html#publish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":257,"kind":2048,"name":"pong","url":"classes/mqttendpoint.html#pong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttEndpoint"},{"id":258,"kind":256,"name":"MqttMessage","url":"interfaces/mqttmessage.html","classes":"tsd-kind-interface"},{"id":259,"kind":2048,"name":"messageId","url":"interfaces/mqttmessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"MqttMessage"},{"id":260,"kind":128,"name":"MqttPublishMessage","url":"classes/mqttpublishmessage.html","classes":"tsd-kind-class"},{"id":261,"kind":2048,"name":"messageId","url":"classes/mqttpublishmessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":262,"kind":2048,"name":"qosLevel","url":"classes/mqttpublishmessage.html#qoslevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":263,"kind":2048,"name":"isDup","url":"classes/mqttpublishmessage.html#isdup","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":264,"kind":2048,"name":"isRetain","url":"classes/mqttpublishmessage.html#isretain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":265,"kind":2048,"name":"topicName","url":"classes/mqttpublishmessage.html#topicname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":266,"kind":2048,"name":"payload","url":"classes/mqttpublishmessage.html#payload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttPublishMessage"},{"id":267,"kind":128,"name":"MqttServer","url":"classes/mqttserver.html","classes":"tsd-kind-class"},{"id":268,"kind":2048,"name":"create","url":"classes/mqttserver.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"MqttServer"},{"id":269,"kind":2048,"name":"listen","url":"classes/mqttserver.html#listen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":270,"kind":2048,"name":"endpointHandler","url":"classes/mqttserver.html#endpointhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":271,"kind":2048,"name":"exceptionHandler","url":"classes/mqttserver.html#exceptionhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":272,"kind":2048,"name":"actualPort","url":"classes/mqttserver.html#actualport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":273,"kind":2048,"name":"close","url":"classes/mqttserver.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttServer"},{"id":274,"kind":128,"name":"MqttSubAckMessage","url":"classes/mqttsubackmessage.html","classes":"tsd-kind-class"},{"id":275,"kind":2048,"name":"messageId","url":"classes/mqttsubackmessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubAckMessage"},{"id":276,"kind":2048,"name":"grantedQoSLevels","url":"classes/mqttsubackmessage.html#grantedqoslevels","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubAckMessage"},{"id":277,"kind":128,"name":"MqttSubscribeMessage","url":"classes/mqttsubscribemessage.html","classes":"tsd-kind-class"},{"id":278,"kind":2048,"name":"messageId","url":"classes/mqttsubscribemessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubscribeMessage"},{"id":279,"kind":2048,"name":"topicSubscriptions","url":"classes/mqttsubscribemessage.html#topicsubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttSubscribeMessage"},{"id":280,"kind":128,"name":"MqttTopicSubscription","url":"classes/mqtttopicsubscription.html","classes":"tsd-kind-class"},{"id":281,"kind":2048,"name":"topicName","url":"classes/mqtttopicsubscription.html#topicname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttTopicSubscription"},{"id":282,"kind":2048,"name":"qualityOfService","url":"classes/mqtttopicsubscription.html#qualityofservice","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttTopicSubscription"},{"id":283,"kind":128,"name":"MqttUnsubscribeMessage","url":"classes/mqttunsubscribemessage.html","classes":"tsd-kind-class"},{"id":284,"kind":2048,"name":"messageId","url":"classes/mqttunsubscribemessage.html#messageid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttUnsubscribeMessage"},{"id":285,"kind":2048,"name":"topics","url":"classes/mqttunsubscribemessage.html#topics","classes":"tsd-kind-method tsd-parent-kind-class","parent":"MqttUnsubscribeMessage"}]}; \ No newline at end of file diff --git a/docs/@vertx/vertx-mqtt/classes/mqttauth.html b/docs/@vertx/vertx-mqtt/classes/mqttauth.html index 22f0a59cc..26db30fab 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttauth.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttauth.html @@ -72,6 +72,104 @@

          Hierarchy

    • +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns MqttAuth

      +
      • +
    • + +

      Parameters

      + +

      Returns MqttAuth

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the password provided by the remote MQTT client

      +
      • +
    +
    +
    + +

    getUsername

    +
      +
    • getUsername(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the username provided by the remote MQTT client

      +
      • +
    +
    +
  • -
    qosLevel: MqttQoS
    +
    qosLevel: any

    QoS level

    @@ -611,17 +629,20 @@
    publishSentHandler: function
    • -

    Properties

    -
    - -

    autoGeneratedClientId

    -
    autoGeneratedClientId: boolean
    - -
    -
    -

    Set if the MQTT client must generate clientId automatically - (default is true)

    -
    -
    -
    param
    -

    clientId generated automatically

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    autoKeepAlive

    -
    autoKeepAlive: boolean
    - -
    -
    -

    Set if the MQTT client must handle PINGREQ automatically - (default is true)

    -
    -
    -
    param
    -

    ping request handled automatically

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    cleanSession

    -
    cleanSession: boolean
    - -
    -
    -

    Set to start with a clean session (or not)

    -
    -
    -
    param
    -

    if clean session should be activated

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    clientId

    -
    clientId: string
    - -
    -
    -

    Set the client identifier

    -
    -
    -
    param
    -

    client identifier

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): MqttClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    getClientId

    +
      +
    • getClientId(): string
      • +
    +
      +
    • + +
      +
      +

      Set the client identifier

      +
      +
      +

      Returns string

      +

      current options instance

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    hostnameVerificationAlgorithm

    -
    hostnameVerificationAlgorithm: string
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - -
    -
    -

    Do the same thing as {@link MqttClientOptions#setKeepAliveTimeSeconds(int)}. Use it instead.

    -
    -
    +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getHostnameVerificationAlgorithm

    +
      +
    • getHostnameVerificationAlgorithm(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    keepAliveTimeSeconds

    -
    keepAliveTimeSeconds: number
    - -
    -
    -

    Set the keep alive timeout in seconds

    -
    -
    -
    param
    -

    keep alive timeout in seconds

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +
      +
      +

      Do the same thing as {@link MqttClientOptions#setKeepAliveTimeSeconds(int)}. Use it instead.

      +
      +
      +

      Returns number

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getKeepAliveTimeSeconds

    +
      +
    • getKeepAliveTimeSeconds(): number
      • +
    +
      +
    • + +
      +
      +

      Set the keep alive timeout in seconds

      +
      +
      +

      Returns number

      +

      current options instance

      +
      • +
    -
    - -

    maxInflightQueue

    -
    maxInflightQueue: number
    - -
    -
    -

    Set max count of unacknowledged messages

    -
    -
    -
    param
    -

    max count of unacknowledged messages

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    maxMessageSize

    -
    maxMessageSize: number
    - -
    -
    -

    Set max MQTT message size

    -
    -
    -
    param
    -

    max MQTT message size

    -
    -
    returns
    -

    MQTT client options instance

    -
    -
    -
    +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getMaxInflightQueue

    +
      +
    • getMaxInflightQueue(): number
      • +
    +
      +
    • + +
      +
      +

      Set max count of unacknowledged messages

      +
      +
      +

      Returns number

      +

      current options instance

      +
      • +
    +
    +
    + +

    getMaxMessageSize

    +
      +
    • getMaxMessageSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set max MQTT message size

      +
      +
      +

      Returns number

      +

      MQTT client options instance

      +
      • +
    +
    +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    +
    +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPassword

    +
      +
    • getPassword(): string
      • +
    +
      +
    • + +
      +
      +

      Set the password

      +
      +
      +

      Returns string

      +

      current options instance

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +

      Returns ProxyOptions

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReconnectAttempts

    +
      +
    • getReconnectAttempts(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getReconnectInterval

    +
      +
    • getReconnectInterval(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getUsername

    +
      +
    • getUsername(): string
      • +
    +
      +
    • + +
      +
      +

      Set the username

      +
      +
      +

      Returns string

      +

      current options instance

      +
      • +
    +
    +
    + +

    getWillMessage

    +
      +
    • getWillMessage(): string
      • +
    +
      +
    • + +
      +
      +

      Set the content of the will message

      +
      +
      +

      Returns string

      +

      current options instance

      +
      • +
    +
    +
    + +

    getWillQoS

    +
      +
    • getWillQoS(): number
      • +
    +
      +
    • + +
      +
      +

      Set the QoS level for the will message

      +
      +
      +

      Returns number

      +

      current options instance

      +
      • +
    +
    +
    + +

    getWillTopic

    +
      +
    • getWillTopic(): string
      • +
    +
      +
    • + +
      +
      +

      Set the topic on which the will message will be published

      +
      +
      +

      Returns string

      +

      current options instance

      +
      • +
    +
    +
    + +

    isAutoGeneratedClientId

    +
      +
    • isAutoGeneratedClientId(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set if the MQTT client must generate clientId automatically + (default is true)

      +
      +
      +

      Returns boolean

      +

      current options instance

      +
      • +
    +
    +
    + +

    isAutoKeepAlive

    +
      +
    • isAutoKeepAlive(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set if the MQTT client must handle PINGREQ automatically + (default is true)

      +
      +
      +

      Returns boolean

      +

      current options instance

      +
      • +
    +
    +
    + +

    isCleanSession

    +
      +
    • isCleanSession(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set to start with a clean session (or not)

      +
      +
      +

      Returns boolean

      +

      current options instance

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isWillFlag

    +
      +
    • isWillFlag(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set if will information are provided on connection

      +
      +
      +

      Returns boolean

      +

      current options instance

      +
      • +
    +
    +
    + +

    isWillRetain

    +
      +
    • isWillRetain(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set if the will message must be retained

      +
      +
      +

      Returns boolean

      +

      current options instance

      +
      • +
    +
    +
    + +

    setAutoGeneratedClientId

    + +
      +
    • + +
      +
      +

      Set if the MQTT client must generate clientId automatically + (default is true)

      +
      +
      +

      Parameters

      +
        +
      • +
        autoGeneratedClientId: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    +
    +
    + +

    setAutoKeepAlive

    + +
      +
    • + +
      +
      +

      Set if the MQTT client must handle PINGREQ automatically + (default is true)

      +
      +
      +

      Parameters

      +
        +
      • +
        autoKeepAlive: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    +
    +
    + +

    setCleanSession

    + +
      +
    • + +
      +
      +

      Set to start with a clean session (or not)

      +
      +
      +

      Parameters

      +
        +
      • +
        cleanSession: boolean
        +
        +

        if clean session should be activated

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    +
    +
    + +

    setClientId

    + +
      +
    • + +
      +
      +

      Set the client identifier

      +
      +
      +

      Parameters

      +
        +
      • +
        clientId: string
        +
        +

        client identifier

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): MqttClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setHostnameVerificationAlgorithm

    +
      +
    • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): MqttClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        hostnameVerificationAlgorithm: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +
      +
      +

      Do the same thing as {@link MqttClientOptions#setKeepAliveTimeSeconds(int)}. Use it instead.

      +
      +
      +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): MqttClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setKeepAliveTimeSeconds

    + +
      +
    • + +
      +
      +

      Set the keep alive timeout in seconds

      +
      +
      +

      Parameters

      +
        +
      • +
        keepAliveTimeSeconds: number
        +
        +

        keep alive timeout in seconds

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setLocalAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setMaxInflightQueue

    + +
      +
    • + +
      +
      +

      Set max count of unacknowledged messages

      +
      +
      +

      Parameters

      +
        +
      • +
        maxInflightQueue: number
        +
        +

        max count of unacknowledged messages

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    +
    +
    + +

    setMaxMessageSize

    + +
      +
    • + +
      +
      +

      Set max MQTT message size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxMessageSize: number
        +
        +

        max MQTT message size

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      MQTT client options instance

      +
      • +
    +
    +
    + +

    setMetricsName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): MqttClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    password

    -
    password: string
    - -
    -
    -

    Set the password

    -
    -
    -
    param
    -

    password

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setPassword

    + +
      +
    • + +
      +
      +

      Set the password

      +
      +
      +

      Parameters

      +
        +
      • +
        password: string
        +
        +

        password

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - +
    + +

    setProxyOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    reconnectAttempts

    -
    reconnectAttempts: number
    - +
    + +

    setReconnectAttempts

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectAttempts: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    reconnectInterval

    -
    reconnectInterval: number
    - +
    + +

    setReconnectInterval

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reconnectInterval: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - +
    + +

    setTrustAll

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns MqttClientOptions

      +
      • +
    -
    - -

    username

    -
    username: string
    - -
    -
    -

    Set the username

    -
    -
    -
    param
    -

    username

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setUsername

    + +
      +
    • + +
      +
      +

      Set the username

      +
      +
      +

      Parameters

      +
        +
      • +
        username: string
        +
        +

        username

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    -
    - -

    willFlag

    -
    willFlag: boolean
    - -
    -
    -

    Set if will information are provided on connection

    -
    -
    -
    param
    -

    if will information are provided on connection

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setWillFlag

    + +
      +
    • + +
      +
      +

      Set if will information are provided on connection

      +
      +
      +

      Parameters

      +
        +
      • +
        willFlag: boolean
        +
        +

        if will information are provided on connection

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    -
    - -

    willMessage

    -
    willMessage: string
    - -
    -
    -

    Set the content of the will message

    -
    -
    -
    param
    -

    content of the will message

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setWillMessage

    + +
      +
    • + +
      +
      +

      Set the content of the will message

      +
      +
      +

      Parameters

      +
        +
      • +
        willMessage: string
        +
        +

        content of the will message

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    -
    - -

    willQoS

    -
    willQoS: number
    - -
    -
    -

    Set the QoS level for the will message

    -
    -
    -
    param
    -

    QoS level for the will message

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setWillQoS

    + +
      +
    • + +
      +
      +

      Set the QoS level for the will message

      +
      +
      +

      Parameters

      +
        +
      • +
        willQoS: number
        +
        +

        QoS level for the will message

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    -
    - -

    willRetain

    -
    willRetain: boolean
    - -
    -
    -

    Set if the will message must be retained

    -
    -
    -
    param
    -

    if thw will message must be retained

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setWillRetain

    + +
      +
    • + +
      +
      +

      Set if the will message must be retained

      +
      +
      +

      Parameters

      +
        +
      • +
        willRetain: boolean
        +
        +

        if thw will message must be retained

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    -
    - -

    willTopic

    -
    willTopic: string
    - -
    -
    -

    Set the topic on which the will message will be published

    -
    -
    -
    param
    -

    topic on which the will message will be published

    -
    -
    returns
    -

    current options instance

    -
    -
    -
    +
    + +

    setWillTopic

    + +
      +
    • + +
      +
      +

      Set the topic on which the will message will be published

      +
      +
      +

      Parameters

      +
        +
      • +
        willTopic: string
        +
        +

        topic on which the will message will be published

        +
        +
        • +
      +

      Returns MqttClientOptions

      +

      current options instance

      +
      • +
    @@ -848,155 +2534,317 @@

    willTopic

  • MqttClientOptions
    • diff --git a/docs/@vertx/vertx-mqtt/classes/mqttconnackmessage.html b/docs/@vertx/vertx-mqtt/classes/mqttconnackmessage.html index 64588c6c8..8d885eec1 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttconnackmessage.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttconnackmessage.html @@ -93,18 +93,18 @@

    Methods

    code

      -
    • code(): MqttConnectReturnCode
      • +
    • code(): any
    • -

      Returns MqttConnectReturnCode

      +

      Returns any

      return code from the connection request

    @@ -119,7 +119,7 @@

    isSessionPresent

  • @@ -133,24 +133,24 @@

    Returns boolean

    Static create

    • -

      Create a concrete instance of a Vert.x connack message

      +

      Create a concrete instance of a Vert.x connack message

      Parameters

      • -
        code: MqttConnectReturnCode
        +
        code: any

        return code from the connection request

        diff --git a/docs/@vertx/vertx-mqtt/classes/mqttendpoint.html b/docs/@vertx/vertx-mqtt/classes/mqttendpoint.html index ac30bcb22..d066a69a5 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttendpoint.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttendpoint.html @@ -91,6 +91,7 @@

        Methods

      • isCleanSession
      • isConnected
      • isPublishAutoAck
        • +
      • isSsl
      • isSubscriptionAutoAck
      • keepAliveTimeSeconds
      • lastMessageId
        • @@ -130,18 +131,32 @@

        Methods

        accept

        • -

          Sends the CONNACK message to the remote MQTT client with "connection accepted" +

          Like {@link #accept(boolean)} with no session is present.

          +
          +
          +

          Returns MqttEndpoint

          +
          • +
        • + +
          +
          +

          Sends the CONNACK message to the remote MQTT client with "connection accepted" return code. See {@link #reject(MqttConnectReturnCode)} for refusing connection

          @@ -169,7 +184,7 @@

          auth

        • @@ -189,12 +204,12 @@

          autoKeepAlive

        • -

          Enable/disable auto keep alive (sending ping response)

          +

          Enable/disable auto keep alive (sending ping response)

          Parameters

          @@ -221,7 +236,7 @@

          clientIdentifier

        • @@ -241,12 +256,12 @@

          close

        • -

          Close the endpoint, so the connection with remote MQTT client

          +

          Close the endpoint, so the connection with remote MQTT client

          Returns void

          @@ -263,12 +278,12 @@

          closeHandler

        • -

          Set a close handler. This will be called when the MQTT endpoint is closed

          +

          Set a close handler. This will be called when the MQTT endpoint is closed

          Parameters

          @@ -281,17 +296,20 @@
          handler: function
            • -
            • (result: void): void
              • +
            • (res: void): void | Handler<void>

            • Parameters

              • -
                result: void
                +
                res: void
              -

              Returns void

              +

              Returns void + | + Handler<void> +

            • @@ -313,12 +331,12 @@

            disconnectHandler

          • -

            Set a disconnect handler on the MQTT endpoint. This handler is called when a DISCONNECT +

            Set a disconnect handler on the MQTT endpoint. This handler is called when a DISCONNECT message is received by the remote MQTT client

            @@ -332,17 +350,20 @@
            handler: function
              • -
              • (result: void): void
                • +
              • (res: void): void | Handler<void>

              • Parameters

                • -
                  result: void
                  +
                  res: void
                -

                Returns void

                +

                Returns void + | + Handler<void> +

              • @@ -364,12 +385,12 @@

              exceptionHandler

            • -

              Set an exception handler. This will be called when an error at protocol level happens

              +

              Set an exception handler. This will be called when an error at protocol level happens

              Parameters

              @@ -382,17 +403,20 @@
              handler: function
                • -
                • (result: Error): void
                  • +
                • (res: Error): void | Handler<Error>

                • Parameters

                  • -
                    result: Error
                    +
                    res: Error
                  -

                  Returns void

                  +

                  Returns void + | + Handler<Error> +

                • @@ -414,7 +438,7 @@

                isAutoKeepAlive

              • @@ -434,7 +458,7 @@

                isCleanSession

              • @@ -454,7 +478,7 @@

                isConnected

              • @@ -474,7 +498,7 @@

                isPublishAutoAck

              • @@ -484,6 +508,26 @@

                Returns boolean

    • +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if this {@link io.vertx.mqtt.MqttEndpoint} is encrypted via SSL/TLS.

      +
      • +
    +

    isSubscriptionAutoAck

    @@ -494,7 +538,7 @@

    isSubscriptionAutoAck

  • @@ -514,7 +558,7 @@

    keepAliveTimeSeconds

  • @@ -534,7 +578,7 @@

    lastMessageId

  • @@ -554,7 +598,7 @@

    localAddress

  • @@ -574,12 +618,12 @@

    pingHandler

  • -

    Set the pingreq handler on the MQTT endpoint. This handler is called when a PINGREQ +

    Set the pingreq handler on the MQTT endpoint. This handler is called when a PINGREQ message is received by the remote MQTT client. In any case the endpoint sends the PINGRESP internally after executing this handler.

    @@ -594,17 +638,20 @@
    handler: function
      • -
      • (result: void): void
        • +
      • (res: void): void | Handler<void>

      • Parameters

        • -
          result: void
          +
          res: void
        -

        Returns void

        +

        Returns void + | + Handler<void> +

      • @@ -626,12 +673,12 @@

      pong

    • -

      Sends the PINGRESP message to the remote MQTT client

      +

      Sends the PINGRESP message to the remote MQTT client

      Returns MqttEndpoint

      @@ -649,7 +696,7 @@

      protocolName

    • @@ -669,7 +716,7 @@

      protocolVersion

    • @@ -683,18 +730,19 @@

      Returns number

      publish

        -
      • publish(topic: string, payload: Buffer, qosLevel: MqttQoS, isDup: boolean, isRetain: boolean): MqttEndpoint
        • +
      • publish(topic: string, payload: Buffer, qosLevel: any, isDup: boolean, isRetain: boolean): MqttEndpoint
        • +
      • publish(topic: string, payload: Buffer, qosLevel: any, isDup: boolean, isRetain: boolean, publishSentHandler: function): MqttEndpoint
      • -

        Sends the PUBLISH message to the remote MQTT client

        +

        Sends the PUBLISH message to the remote MQTT client

        Parameters

        @@ -712,7 +760,7 @@
        payload: Buffer

    • -
      qosLevel: MqttQoS
      +
      qosLevel: any

      quality of service level

      @@ -733,6 +781,80 @@
      isRetain: boolean

      Returns MqttEndpoint

      a reference to this, so the API can be used fluently

      • +
    • + +
      +
      +

      Sends the PUBLISH message to the remote MQTT server

      +
      +
      +

      Parameters

      +
        +
      • +
        topic: string
        +
        +

        topic on which the message is published

        +
        +
        • +
      • +
        payload: Buffer
        +
        +

        message payload

        +
        +
        • +
      • +
        qosLevel: any
        +
        +

        QoS level

        +
        +
        • +
      • +
        isDup: boolean
        +
        +

        if the message is a duplicate

        +
        +
        • +
      • +
        isRetain: boolean
        +
        +

        if the message needs to be retained

        +
        +
        • +
      • +
        publishSentHandler: function
        +
        +

        handler called after PUBLISH packet sent with a packetId

        +
        +
          +
        • +
            +
          • (res: AsyncResult<number>): void | Handler<AsyncResult<number>>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: AsyncResult<number>
              +
              • +
            +

            Returns void + | + Handler<AsyncResult<number>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns MqttEndpoint

      +

      current MQTT client instance

      +
    • @@ -745,12 +867,12 @@

    publishAcknowledge

  • -

    Sends the PUBACK message to the remote MQTT client

    +

    Sends the PUBACK message to the remote MQTT client

    Parameters

    @@ -777,12 +899,12 @@

    publishAcknowledgeHandler

  • -

    Set the puback handler on the MQTT endpoint. This handler is called when a PUBACK +

    Set the puback handler on the MQTT endpoint. This handler is called when a PUBACK message is received by the remote MQTT client

    @@ -796,17 +918,20 @@
    handler: function
      • -
      • (result: number): void
        • +
      • (res: number): void | Handler<number>

      • Parameters

        • -
          result: number
          +
          res: number
        -

        Returns void

        +

        Returns void + | + Handler<number> +

      • @@ -828,12 +953,12 @@

      publishAutoAck

    • -

      Enable/disable publishing (in/out) auto acknowledge

      +

      Enable/disable publishing (in/out) auto acknowledge

      Parameters

      @@ -860,12 +985,12 @@

      publishComplete

    • -

      Sends the PUBCOMP message to the remote MQTT client

      +

      Sends the PUBCOMP message to the remote MQTT client

      Parameters

      @@ -892,12 +1017,12 @@

      publishCompletionHandler

    • -

      Set the pubcomp handler on the MQTT endpoint. This handler is called when a PUBCOMP +

      Set the pubcomp handler on the MQTT endpoint. This handler is called when a PUBCOMP message is received by the remote MQTT client

      @@ -911,17 +1036,20 @@
      handler: function
        • -
        • (result: number): void
          • +
        • (res: number): void | Handler<number>

        • Parameters

          • -
            result: number
            +
            res: number
          -

          Returns void

          +

          Returns void + | + Handler<number> +

        • @@ -943,12 +1071,12 @@

        publishHandler

      • -

        Set the publish handler on the MQTT endpoint. This handler is called when a PUBLISH +

        Set the publish handler on the MQTT endpoint. This handler is called when a PUBLISH message is received by the remote MQTT client

        @@ -962,17 +1090,20 @@
        handler: function
          • @@ -994,12 +1125,12 @@

          publishReceived

        • -

          Sends the PUBREC message to the remote MQTT client

          +

          Sends the PUBREC message to the remote MQTT client

          Parameters

          @@ -1026,12 +1157,12 @@

          publishReceivedHandler

        • -

          Set the pubrec handler on the MQTT endpoint. This handler is called when a PUBREC +

          Set the pubrec handler on the MQTT endpoint. This handler is called when a PUBREC message is received by the remote MQTT client

          @@ -1045,17 +1176,20 @@
          handler: function
            • -
            • (result: number): void
              • +
            • (res: number): void | Handler<number>

            • Parameters

              • -
                result: number
                +
                res: number
              -

              Returns void

              +

              Returns void + | + Handler<number> +

            • @@ -1077,12 +1211,12 @@

            publishRelease

          • -

            Sends the PUBREL message to the remote MQTT client

            +

            Sends the PUBREL message to the remote MQTT client

            Parameters

            @@ -1109,12 +1243,12 @@

            publishReleaseHandler

          • -

            Set the pubrel handler on the MQTT endpoint. This handler is called when a PUBREL +

            Set the pubrel handler on the MQTT endpoint. This handler is called when a PUBREL message is received by the remote MQTT client

            @@ -1128,17 +1262,20 @@
            handler: function
              • -
              • (result: number): void
                • +
              • (res: number): void | Handler<number>

              • Parameters

                • -
                  result: number
                  +
                  res: number
                -

                Returns void

                +

                Returns void + | + Handler<number> +

              • @@ -1154,25 +1291,25 @@

              Returns

              reject

              • -

                Sends the CONNACK message to the remote MQTT client rejecting the connection +

                Sends the CONNACK message to the remote MQTT client rejecting the connection request with specified return code. See {@link #accept(boolean)} for accepting connection

                Parameters

                • -
                  returnCode: MqttConnectReturnCode
                  +
                  returnCode: any

                  the connect return code

                  @@ -1193,7 +1330,7 @@

                  remoteAddress

                • @@ -1213,12 +1350,12 @@

                  setClientIdentifier

                • -

                  Set client identifier if not provided by the remote MQTT client (zero-bytes)

                  +

                  Set client identifier if not provided by the remote MQTT client (zero-bytes)

                  Parameters

                  @@ -1239,18 +1376,18 @@

                  Returns

                  subscribeAcknowledge

                    -
                  • subscribeAcknowledge(subscribeMessageId: number, grantedQoSLevels: MqttQoS[]): MqttEndpoint
                    • +
                  • subscribeAcknowledge(subscribeMessageId: number, grantedQoSLevels: any[]): MqttEndpoint
                  • -

                    Sends the SUBACK message to the remote MQTT client

                    +

                    Sends the SUBACK message to the remote MQTT client

                    Parameters

                    @@ -1262,7 +1399,7 @@
                    subscribeMessageId: number
                  • -
                    grantedQoSLevels: MqttQoS[]
                    +
                    grantedQoSLevels: any[]

                    granted QoS levels for the requested topics

                    @@ -1283,12 +1420,12 @@

                    subscribeHandler

                  • -

                    Set a subscribe handler on the MQTT endpoint. This handler is called when a SUBSCRIBE +

                    Set a subscribe handler on the MQTT endpoint. This handler is called when a SUBSCRIBE message is received by the remote MQTT client

                    @@ -1302,17 +1439,20 @@
                    handler: function
                      • @@ -1334,12 +1474,12 @@

                      subscriptionAutoAck

                    • -

                      Enable/disable subscription/unsubscription requests auto acknowledge

                      +

                      Enable/disable subscription/unsubscription requests auto acknowledge

                      Parameters

                      @@ -1365,12 +1505,12 @@

                      unsubscribeAcknowledge

                    • -

                      Sends the UNSUBACK message to the remote MQTT client

                      +

                      Sends the UNSUBACK message to the remote MQTT client

                      Parameters

                      @@ -1397,12 +1537,12 @@

                      unsubscribeHandler

                    • -

                      Set a unsubscribe handler on the MQTT endpoint. This handler is called when a UNSUBSCRIBE +

                      Set a unsubscribe handler on the MQTT endpoint. This handler is called when a UNSUBSCRIBE message is received by the remote MQTT client

                      @@ -1416,17 +1556,20 @@
                      handler: function
    • +
    +

    Implements

    + +

    Index

    @@ -102,7 +108,7 @@

    isDup

  • @@ -122,7 +128,7 @@

    isRetain

  • @@ -141,8 +147,9 @@

    messageId

    • -

    Properties

    -
    - -

    acceptBacklog

    -
    acceptBacklog: number
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    autoClientId

    -
    autoClientId: boolean
    - -
    -
    -

    Set if clientid should be auto-generated when it's "zero-bytes"

    -
    -
    -
    param
    -
    -
    returns
    -

    MQTT server options instance

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    -
    - -

    clientAuth

    -
    clientAuth: ClientAuth
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    -
    - -

    clientAuthRequired

    -
    clientAuthRequired: boolean
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): MqttServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    getAcceptBacklog

    +
      +
    • getAcceptBacklog(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getClientAuth

    +
      +
    • getClientAuth(): ClientAuth
      • +
    +
      +
    • + +

      Returns ClientAuth

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    host

    -
    host: string
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getHost

    +
      +
    • getHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxMessageSize

    -
    maxMessageSize: number
    - -
    -
    -

    Set max MQTT message size

    -
    -
    -
    param
    -

    max MQTT message size (variable header + payload)

    -
    -
    returns
    -

    MQTT server options instance

    -
    -
    -
    +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    getMaxMessageSize

    +
      +
    • getMaxMessageSize(): number
      • +
    +
      +
    • + +
      +
      +

      Set max MQTT message size

      +
      +
      +

      Returns number

      +

      MQTT server options instance

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    -
    - -

    port

    -
    port: number
    - +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    getPort

    +
      +
    • getPort(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    sni

    -
    sni: boolean
    - +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    isAutoClientId

    +
      +
    • isAutoClientId(): boolean
      • +
    +
      +
    • + +
      +
      +

      Set if clientid should be auto-generated when it's "zero-bytes"

      +
      +
      +

      Returns boolean

      +

      MQTT server options instance

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    isClientAuthRequired

    +
      +
    • isClientAuthRequired(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    timeoutOnConnect

    -
    timeoutOnConnect: number
    - -
    -
    -

    Set the timeout on CONNECT packet

    -
    -
    -
    param
    -

    timeout on CONNECT before closing connection

    -
    -
    returns
    -

    MQTT server options instance

    -
    -
    -
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    isSni

    +
      +
    • isSni(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAcceptBacklog

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        acceptBacklog: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setAutoClientId

    + +
      +
    • + +
      +
      +

      Set if clientid should be auto-generated when it's "zero-bytes"

      +
      +
      +

      Parameters

      +
        +
      • +
        autoClientId: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +

      MQTT server options instance

      +
      • +
    +
    +
    + +

    setClientAuth

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuth: ClientAuth
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setClientAuthRequired

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        clientAuthRequired: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): MqttServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        host: string
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): MqttServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setMaxMessageSize

    + +
      +
    • + +
      +
      +

      Set max MQTT message size

      +
      +
      +

      Parameters

      +
        +
      • +
        maxMessageSize: number
        +
        +

        max MQTT message size (variable header + payload)

        +
        +
        • +
      +

      Returns MqttServerOptions

      +

      MQTT server options instance

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): MqttServerOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setPort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        port: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setSni

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sni: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTimeoutOnConnect

    + +
      +
    • + +
      +
      +

      Set the timeout on CONNECT packet

      +
      +
      +

      Parameters

      +
        +
      • +
        timeoutOnConnect: number
        +
        +

        timeout on CONNECT before closing connection

        +
        +
        • +
      +

      Returns MqttServerOptions

      +

      MQTT server options instance

      +
      • +
    +
    +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns MqttServerOptions

      +
      • +
    +
    +
    + +

    timeoutOnConnect

    +
      +
    • timeoutOnConnect(): number
      • +
    +
      +
    • + +
      +
      +

      Set the timeout on CONNECT packet

      +
      +
      +

      Returns number

      +

      MQTT server options instance

      +
      • +
    @@ -569,116 +1827,239 @@

    usePooledBuffers

  • MqttServerOptions
    • diff --git a/docs/@vertx/vertx-mqtt/classes/mqttsubackmessage.html b/docs/@vertx/vertx-mqtt/classes/mqttsubackmessage.html index 7fe1fbd5c..2b68b75f8 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttsubackmessage.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttsubackmessage.html @@ -72,6 +72,12 @@

    Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -98,7 +104,7 @@

    grantedQoSLevels

  • @@ -117,8 +123,9 @@

    messageId

    • diff --git a/docs/@vertx/vertx-mqtt/classes/mqttsubscribemessage.html b/docs/@vertx/vertx-mqtt/classes/mqttsubscribemessage.html index 86aaedb20..2c4a3a3a0 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttsubscribemessage.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttsubscribemessage.html @@ -72,6 +72,12 @@

      Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -97,8 +103,9 @@

    messageId

    • @@ -118,7 +125,7 @@

      topicSubscriptions

    • diff --git a/docs/@vertx/vertx-mqtt/classes/mqtttopicsubscription.html b/docs/@vertx/vertx-mqtt/classes/mqtttopicsubscription.html index 7fc1e9fd8..fd6a894e4 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqtttopicsubscription.html +++ b/docs/@vertx/vertx-mqtt/classes/mqtttopicsubscription.html @@ -92,18 +92,18 @@

      Methods

      qualityOfService

        -
      • qualityOfService(): MqttQoS
        • +
      • qualityOfService(): any
      • -

        Returns MqttQoS

        +

        Returns any

        Quality of Service level for the subscription

      @@ -118,7 +118,7 @@

      topicName

    • diff --git a/docs/@vertx/vertx-mqtt/classes/mqttunsubscribemessage.html b/docs/@vertx/vertx-mqtt/classes/mqttunsubscribemessage.html index 8b6aa2587..576e1a781 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttunsubscribemessage.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttunsubscribemessage.html @@ -72,6 +72,12 @@

      Hierarchy

    +
    +

    Implements

    + +

    Index

    @@ -97,8 +103,9 @@

    messageId

    • @@ -118,7 +125,7 @@

      topics

    • diff --git a/docs/@vertx/vertx-mqtt/classes/mqttwill.html b/docs/@vertx/vertx-mqtt/classes/mqttwill.html index cc2250d9f..41d98a553 100644 --- a/docs/@vertx/vertx-mqtt/classes/mqttwill.html +++ b/docs/@vertx/vertx-mqtt/classes/mqttwill.html @@ -72,6 +72,167 @@

      Hierarchy

    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + +
      +
    • + +

      Returns MqttWill

      +
      • +
    • + +

      Parameters

      + +

      Returns MqttWill

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    getWillMessage

    +
      +
    • getWillMessage(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the payload for the will as provided by the remote MQTT client

      +
      • +
    +
    +
    + +

    getWillQos

    +
      +
    • getWillQos(): number
      • +
    +
      +
    • + +
      +
      +

      Returns number

      +

      the QoS level for the will as provided by the remote MQTT client

      +
      • +
    +
    +
    + +

    getWillTopic

    +
      +
    • getWillTopic(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the topic for the will as provided by the remote MQTT client

      +
      • +
    +
    +
    + +

    isWillFlag

    +
      +
    • isWillFlag(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      the will flag for indicating the will message presence

      +
      • +
    +
    +
    + +

    isWillRetain

    +
      +
    • isWillRetain(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      true if the will must be retained as provided by the remote MQTT client

      +
      • +
    +
    +
    +
    +

    Implemented by

    + +

    Index

    @@ -97,7 +106,7 @@

    messageId

  • diff --git a/docs/@vertx/web-api-contract/assets/js/search.js b/docs/@vertx/web-api-contract/assets/js/search.js index a8cce6809..db789dcd0 100644 --- a/docs/@vertx/web-api-contract/assets/js/search.js +++ b/docs/@vertx/web-api-contract/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","256":"Interface","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"ContainerSerializationStyle","url":"enums/containerserializationstyle.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"csv","url":"enums/containerserializationstyle.html#csv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":2,"kind":16,"name":"ssv","url":"enums/containerserializationstyle.html#ssv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":3,"kind":16,"name":"psv","url":"enums/containerserializationstyle.html#psv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":4,"kind":16,"name":"dsv","url":"enums/containerserializationstyle.html#dsv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":5,"kind":16,"name":"simple_exploded_object","url":"enums/containerserializationstyle.html#simple_exploded_object","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":6,"kind":16,"name":"matrix_exploded_array","url":"enums/containerserializationstyle.html#matrix_exploded_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":7,"kind":4,"name":"ErrorType","url":"enums/errortype.html","classes":"tsd-kind-enum"},{"id":8,"kind":16,"name":"NO_MATCH","url":"enums/errortype.html#no_match","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":9,"kind":16,"name":"NOT_FOUND","url":"enums/errortype.html#not_found","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":10,"kind":16,"name":"UNEXPECTED_ARRAY","url":"enums/errortype.html#unexpected_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":11,"kind":16,"name":"UNEXPECTED_SINGLE_STRING","url":"enums/errortype.html#unexpected_single_string","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":12,"kind":16,"name":"FILE_NOT_FOUND","url":"enums/errortype.html#file_not_found","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":13,"kind":16,"name":"WRONG_CONTENT_TYPE","url":"enums/errortype.html#wrong_content_type","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":14,"kind":16,"name":"EMPTY_VALUE","url":"enums/errortype.html#empty_value","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":15,"kind":16,"name":"UNEXPECTED_ARRAY_SIZE","url":"enums/errortype.html#unexpected_array_size","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":16,"kind":16,"name":"DESERIALIZATION_ERROR","url":"enums/errortype.html#deserialization_error","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":17,"kind":16,"name":"OBJECT_FIELD_NOT_FOUND","url":"enums/errortype.html#object_field_not_found","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":18,"kind":16,"name":"JSON_NOT_PARSABLE","url":"enums/errortype.html#json_not_parsable","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":19,"kind":16,"name":"JSON_INVALID","url":"enums/errortype.html#json_invalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":20,"kind":16,"name":"XML_INVALID","url":"enums/errortype.html#xml_invalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":21,"kind":16,"name":"PATH_NOT_FOUND","url":"enums/errortype.html#path_not_found","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":22,"kind":16,"name":"OPERATION_ID_NOT_FOUND","url":"enums/errortype.html#operation_id_not_found","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":23,"kind":16,"name":"SPEC_INVALID","url":"enums/errortype.html#spec_invalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":24,"kind":16,"name":"MISSING_SECURITY_HANDLER","url":"enums/errortype.html#missing_security_handler","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":25,"kind":16,"name":"INVALID_SPEC_PATH","url":"enums/errortype.html#invalid_spec_path","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":26,"kind":16,"name":"PATH_PARAMETERS_COMBINATION_NOT_SUPPORTED","url":"enums/errortype.html#path_parameters_combination_not_supported","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ErrorType"},{"id":27,"kind":4,"name":"ParameterLocation","url":"enums/parameterlocation.html","classes":"tsd-kind-enum"},{"id":28,"kind":16,"name":"HEADER","url":"enums/parameterlocation.html#header","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":29,"kind":16,"name":"QUERY","url":"enums/parameterlocation.html#query","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":30,"kind":16,"name":"PATH","url":"enums/parameterlocation.html#path","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":31,"kind":16,"name":"FILE","url":"enums/parameterlocation.html#file","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":32,"kind":16,"name":"BODY_FORM","url":"enums/parameterlocation.html#body_form","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":33,"kind":16,"name":"BODY","url":"enums/parameterlocation.html#body","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":34,"kind":16,"name":"BODY_JSON","url":"enums/parameterlocation.html#body_json","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":35,"kind":16,"name":"BODY_XML","url":"enums/parameterlocation.html#body_xml","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":36,"kind":16,"name":"COOKIE","url":"enums/parameterlocation.html#cookie","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":37,"kind":4,"name":"ParameterType","url":"enums/parametertype.html","classes":"tsd-kind-enum"},{"id":38,"kind":16,"name":"GENERIC_STRING","url":"enums/parametertype.html#generic_string","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":39,"kind":16,"name":"EMAIL","url":"enums/parametertype.html#email","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":40,"kind":16,"name":"URI","url":"enums/parametertype.html#uri","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":41,"kind":16,"name":"BOOL","url":"enums/parametertype.html#bool","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":42,"kind":16,"name":"INT","url":"enums/parametertype.html#int","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":43,"kind":16,"name":"FLOAT","url":"enums/parametertype.html#float","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":44,"kind":16,"name":"DOUBLE","url":"enums/parametertype.html#double","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":45,"kind":16,"name":"DATE","url":"enums/parametertype.html#date","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":46,"kind":16,"name":"DATETIME","url":"enums/parametertype.html#datetime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":47,"kind":16,"name":"TIME","url":"enums/parametertype.html#time","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":48,"kind":16,"name":"BASE64","url":"enums/parametertype.html#base64","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":49,"kind":16,"name":"IPV4","url":"enums/parametertype.html#ipv4","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":50,"kind":16,"name":"IPV6","url":"enums/parametertype.html#ipv6","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":51,"kind":16,"name":"HOSTNAME","url":"enums/parametertype.html#hostname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":52,"kind":128,"name":"RouterFactoryOptions","url":"classes/routerfactoryoptions.html","classes":"tsd-kind-class"},{"id":53,"kind":1024,"name":"bodyHandler","url":"classes/routerfactoryoptions.html#bodyhandler","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":54,"kind":1024,"name":"mountNotImplementedHandler","url":"classes/routerfactoryoptions.html#mountnotimplementedhandler","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":55,"kind":1024,"name":"mountResponseContentTypeHandler","url":"classes/routerfactoryoptions.html#mountresponsecontenttypehandler","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":56,"kind":1024,"name":"mountValidationFailureHandler","url":"classes/routerfactoryoptions.html#mountvalidationfailurehandler","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":57,"kind":1024,"name":"requireSecurityHandlers","url":"classes/routerfactoryoptions.html#requiresecurityhandlers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":58,"kind":128,"name":"ContainerDeserializer","url":"classes/containerdeserializer.html","classes":"tsd-kind-class"},{"id":59,"kind":2048,"name":"deserializeArray","url":"classes/containerdeserializer.html#deserializearray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ContainerDeserializer"},{"id":60,"kind":2048,"name":"deserializeObject","url":"classes/containerdeserializer.html#deserializeobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ContainerDeserializer"},{"id":61,"kind":128,"name":"CustomValidator","url":"classes/customvalidator.html","classes":"tsd-kind-class"},{"id":62,"kind":2048,"name":"validate","url":"classes/customvalidator.html#validate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CustomValidator"},{"id":63,"kind":256,"name":"HTTPOperationRequestValidationHandler","url":"interfaces/httpoperationrequestvalidationhandler.html","classes":"tsd-kind-interface"},{"id":64,"kind":2048,"name":"handle","url":"interfaces/httpoperationrequestvalidationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HTTPOperationRequestValidationHandler"},{"id":65,"kind":2048,"name":"parseOperationSpec","url":"interfaces/httpoperationrequestvalidationhandler.html#parseoperationspec","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HTTPOperationRequestValidationHandler"},{"id":66,"kind":128,"name":"HTTPRequestValidationHandler","url":"classes/httprequestvalidationhandler.html","classes":"tsd-kind-class"},{"id":67,"kind":2048,"name":"handle","url":"classes/httprequestvalidationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":68,"kind":2048,"name":"create","url":"classes/httprequestvalidationhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HTTPRequestValidationHandler"},{"id":69,"kind":2048,"name":"addPathParam","url":"classes/httprequestvalidationhandler.html#addpathparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":70,"kind":2048,"name":"addPathParamWithPattern","url":"classes/httprequestvalidationhandler.html#addpathparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":71,"kind":2048,"name":"addPathParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addpathparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":72,"kind":2048,"name":"addQueryParam","url":"classes/httprequestvalidationhandler.html#addqueryparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":73,"kind":2048,"name":"addQueryParamWithPattern","url":"classes/httprequestvalidationhandler.html#addqueryparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":74,"kind":2048,"name":"addQueryParamsArray","url":"classes/httprequestvalidationhandler.html#addqueryparamsarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":75,"kind":2048,"name":"addQueryParamsArrayWithPattern","url":"classes/httprequestvalidationhandler.html#addqueryparamsarraywithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":76,"kind":2048,"name":"addQueryParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addqueryparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":77,"kind":2048,"name":"addHeaderParam","url":"classes/httprequestvalidationhandler.html#addheaderparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":78,"kind":2048,"name":"addHeaderParamWithPattern","url":"classes/httprequestvalidationhandler.html#addheaderparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":79,"kind":2048,"name":"addHeaderParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addheaderparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":80,"kind":2048,"name":"addFormParam","url":"classes/httprequestvalidationhandler.html#addformparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":81,"kind":2048,"name":"addFormParamWithPattern","url":"classes/httprequestvalidationhandler.html#addformparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":82,"kind":2048,"name":"addFormParamsArray","url":"classes/httprequestvalidationhandler.html#addformparamsarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":83,"kind":2048,"name":"addFormParamsArrayWithPattern","url":"classes/httprequestvalidationhandler.html#addformparamsarraywithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":84,"kind":2048,"name":"addFormParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addformparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":85,"kind":2048,"name":"addCustomValidatorFunction","url":"classes/httprequestvalidationhandler.html#addcustomvalidatorfunction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":86,"kind":2048,"name":"addJsonBodySchema","url":"classes/httprequestvalidationhandler.html#addjsonbodyschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":87,"kind":2048,"name":"addXMLBodySchema","url":"classes/httprequestvalidationhandler.html#addxmlbodyschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":88,"kind":2048,"name":"addMultipartRequiredFile","url":"classes/httprequestvalidationhandler.html#addmultipartrequiredfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":89,"kind":2048,"name":"addExpectedContentType","url":"classes/httprequestvalidationhandler.html#addexpectedcontenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":90,"kind":128,"name":"OpenAPI3RequestValidationHandler","url":"classes/openapi3requestvalidationhandler.html","classes":"tsd-kind-class"},{"id":91,"kind":2048,"name":"handle","url":"classes/openapi3requestvalidationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RequestValidationHandler"},{"id":92,"kind":2048,"name":"parseOperationSpec","url":"classes/openapi3requestvalidationhandler.html#parseoperationspec","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RequestValidationHandler"},{"id":93,"kind":128,"name":"OpenAPI3RouterFactory","url":"classes/openapi3routerfactory.html","classes":"tsd-kind-class"},{"id":94,"kind":2048,"name":"addSecurityHandler","url":"classes/openapi3routerfactory.html#addsecurityhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":95,"kind":2048,"name":"addHandler","url":"classes/openapi3routerfactory.html#addhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":96,"kind":2048,"name":"addFailureHandler","url":"classes/openapi3routerfactory.html#addfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":97,"kind":2048,"name":"setOptions","url":"classes/openapi3routerfactory.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":98,"kind":2048,"name":"getOptions","url":"classes/openapi3routerfactory.html#getoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":99,"kind":2048,"name":"setValidationFailureHandler","url":"classes/openapi3routerfactory.html#setvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":100,"kind":2048,"name":"enableValidationFailureHandler","url":"classes/openapi3routerfactory.html#enablevalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":101,"kind":2048,"name":"mountOperationsWithoutHandlers","url":"classes/openapi3routerfactory.html#mountoperationswithouthandlers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":102,"kind":2048,"name":"getRouter","url":"classes/openapi3routerfactory.html#getrouter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":103,"kind":2048,"name":"addSecuritySchemaScopeValidator","url":"classes/openapi3routerfactory.html#addsecurityschemascopevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":104,"kind":2048,"name":"addHandlerByOperationId","url":"classes/openapi3routerfactory.html#addhandlerbyoperationid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":105,"kind":2048,"name":"addFailureHandlerByOperationId","url":"classes/openapi3routerfactory.html#addfailurehandlerbyoperationid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":106,"kind":2048,"name":"create","url":"classes/openapi3routerfactory.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OpenAPI3RouterFactory"},{"id":107,"kind":2048,"name":"createRouterFactoryFromFile","url":"classes/openapi3routerfactory.html#createrouterfactoryfromfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OpenAPI3RouterFactory"},{"id":108,"kind":2048,"name":"createRouterFactoryFromURL","url":"classes/openapi3routerfactory.html#createrouterfactoryfromurl","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OpenAPI3RouterFactory"},{"id":109,"kind":128,"name":"ParameterTypeValidator","url":"classes/parametertypevalidator.html","classes":"tsd-kind-class"},{"id":110,"kind":2048,"name":"isValid","url":"classes/parametertypevalidator.html#isvalid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":111,"kind":2048,"name":"isValidCollection","url":"classes/parametertypevalidator.html#isvalidcollection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":112,"kind":2048,"name":"getDefault","url":"classes/parametertypevalidator.html#getdefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":113,"kind":2048,"name":"hasDefault","url":"classes/parametertypevalidator.html#hasdefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":114,"kind":2048,"name":"createIntegerTypeValidator","url":"classes/parametertypevalidator.html#createintegertypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":115,"kind":2048,"name":"createLongTypeValidator","url":"classes/parametertypevalidator.html#createlongtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":116,"kind":2048,"name":"createFloatTypeValidator","url":"classes/parametertypevalidator.html#createfloattypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":117,"kind":2048,"name":"createDoubleTypeValidator","url":"classes/parametertypevalidator.html#createdoubletypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":118,"kind":2048,"name":"createStringTypeValidator","url":"classes/parametertypevalidator.html#createstringtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":119,"kind":2048,"name":"createBooleanTypeValidator","url":"classes/parametertypevalidator.html#createbooleantypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":120,"kind":2048,"name":"createStringEnumTypeValidator","url":"classes/parametertypevalidator.html#createstringenumtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":121,"kind":2048,"name":"createEnumTypeValidatorWithInnerValidator","url":"classes/parametertypevalidator.html#createenumtypevalidatorwithinnervalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":122,"kind":2048,"name":"createArrayTypeValidator","url":"classes/parametertypevalidator.html#createarraytypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":123,"kind":128,"name":"ParameterValidationRule","url":"classes/parametervalidationrule.html","classes":"tsd-kind-class"},{"id":124,"kind":2048,"name":"getName","url":"classes/parametervalidationrule.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":125,"kind":2048,"name":"validateSingleParam","url":"classes/parametervalidationrule.html#validatesingleparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":126,"kind":2048,"name":"validateArrayParam","url":"classes/parametervalidationrule.html#validatearrayparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":127,"kind":2048,"name":"isOptional","url":"classes/parametervalidationrule.html#isoptional","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":128,"kind":2048,"name":"parameterTypeValidator","url":"classes/parametervalidationrule.html#parametertypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":129,"kind":2048,"name":"allowEmptyValue","url":"classes/parametervalidationrule.html#allowemptyvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":130,"kind":128,"name":"RequestParameter","url":"classes/requestparameter.html","classes":"tsd-kind-class"},{"id":131,"kind":2048,"name":"setName","url":"classes/requestparameter.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":132,"kind":2048,"name":"setValue","url":"classes/requestparameter.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":133,"kind":2048,"name":"getName","url":"classes/requestparameter.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":134,"kind":2048,"name":"getObjectKeys","url":"classes/requestparameter.html#getobjectkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":135,"kind":2048,"name":"getObjectValue","url":"classes/requestparameter.html#getobjectvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":136,"kind":2048,"name":"isObject","url":"classes/requestparameter.html#isobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":137,"kind":2048,"name":"getArray","url":"classes/requestparameter.html#getarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":138,"kind":2048,"name":"isArray","url":"classes/requestparameter.html#isarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":139,"kind":2048,"name":"getString","url":"classes/requestparameter.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":140,"kind":2048,"name":"isString","url":"classes/requestparameter.html#isstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":141,"kind":2048,"name":"getInteger","url":"classes/requestparameter.html#getinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":142,"kind":2048,"name":"isInteger","url":"classes/requestparameter.html#isinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":143,"kind":2048,"name":"getLong","url":"classes/requestparameter.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":144,"kind":2048,"name":"isLong","url":"classes/requestparameter.html#islong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":145,"kind":2048,"name":"getFloat","url":"classes/requestparameter.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":146,"kind":2048,"name":"isFloat","url":"classes/requestparameter.html#isfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":147,"kind":2048,"name":"getDouble","url":"classes/requestparameter.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":148,"kind":2048,"name":"isDouble","url":"classes/requestparameter.html#isdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":149,"kind":2048,"name":"getBoolean","url":"classes/requestparameter.html#getboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":150,"kind":2048,"name":"isBoolean","url":"classes/requestparameter.html#isboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":151,"kind":2048,"name":"getJsonObject","url":"classes/requestparameter.html#getjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":152,"kind":2048,"name":"isJsonObject","url":"classes/requestparameter.html#isjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":153,"kind":2048,"name":"getJsonArray","url":"classes/requestparameter.html#getjsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":154,"kind":2048,"name":"isJsonArray","url":"classes/requestparameter.html#isjsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":155,"kind":2048,"name":"isNull","url":"classes/requestparameter.html#isnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":156,"kind":2048,"name":"isEmpty","url":"classes/requestparameter.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":157,"kind":2048,"name":"merge","url":"classes/requestparameter.html#merge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":158,"kind":2048,"name":"create","url":"classes/requestparameter.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RequestParameter"},{"id":159,"kind":128,"name":"RequestParameters","url":"classes/requestparameters.html","classes":"tsd-kind-class"},{"id":160,"kind":2048,"name":"pathParametersNames","url":"classes/requestparameters.html#pathparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":161,"kind":2048,"name":"pathParameter","url":"classes/requestparameters.html#pathparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":162,"kind":2048,"name":"queryParametersNames","url":"classes/requestparameters.html#queryparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":163,"kind":2048,"name":"queryParameter","url":"classes/requestparameters.html#queryparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":164,"kind":2048,"name":"headerParametersNames","url":"classes/requestparameters.html#headerparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":165,"kind":2048,"name":"headerParameter","url":"classes/requestparameters.html#headerparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":166,"kind":2048,"name":"cookieParametersNames","url":"classes/requestparameters.html#cookieparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":167,"kind":2048,"name":"cookieParameter","url":"classes/requestparameters.html#cookieparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":168,"kind":2048,"name":"formParametersNames","url":"classes/requestparameters.html#formparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":169,"kind":2048,"name":"formParameter","url":"classes/requestparameters.html#formparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":170,"kind":2048,"name":"body","url":"classes/requestparameters.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":171,"kind":256,"name":"RouterFactory","url":"interfaces/routerfactory.html","classes":"tsd-kind-interface"},{"id":172,"kind":2048,"name":"addSecurityHandler","url":"interfaces/routerfactory.html#addsecurityhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":173,"kind":2048,"name":"addHandler","url":"interfaces/routerfactory.html#addhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":174,"kind":2048,"name":"addFailureHandler","url":"interfaces/routerfactory.html#addfailurehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":175,"kind":2048,"name":"setOptions","url":"interfaces/routerfactory.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":176,"kind":2048,"name":"getOptions","url":"interfaces/routerfactory.html#getoptions","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":177,"kind":2048,"name":"setValidationFailureHandler","url":"interfaces/routerfactory.html#setvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":178,"kind":2048,"name":"enableValidationFailureHandler","url":"interfaces/routerfactory.html#enablevalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":179,"kind":2048,"name":"mountOperationsWithoutHandlers","url":"interfaces/routerfactory.html#mountoperationswithouthandlers","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":180,"kind":2048,"name":"getRouter","url":"interfaces/routerfactory.html#getrouter","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":181,"kind":256,"name":"ValidationHandler","url":"interfaces/validationhandler.html","classes":"tsd-kind-interface"},{"id":182,"kind":2048,"name":"handle","url":"interfaces/validationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ValidationHandler"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","256":"Interface","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"ContainerSerializationStyle","url":"enums/containerserializationstyle.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"csv","url":"enums/containerserializationstyle.html#csv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":2,"kind":16,"name":"ssv","url":"enums/containerserializationstyle.html#ssv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":3,"kind":16,"name":"psv","url":"enums/containerserializationstyle.html#psv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":4,"kind":16,"name":"dsv","url":"enums/containerserializationstyle.html#dsv","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":5,"kind":16,"name":"simple_exploded_object","url":"enums/containerserializationstyle.html#simple_exploded_object","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":6,"kind":16,"name":"matrix_exploded_array","url":"enums/containerserializationstyle.html#matrix_exploded_array","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ContainerSerializationStyle"},{"id":7,"kind":4,"name":"ParameterLocation","url":"enums/parameterlocation.html","classes":"tsd-kind-enum"},{"id":8,"kind":16,"name":"HEADER","url":"enums/parameterlocation.html#header","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":9,"kind":16,"name":"QUERY","url":"enums/parameterlocation.html#query","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":10,"kind":16,"name":"PATH","url":"enums/parameterlocation.html#path","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":11,"kind":16,"name":"FILE","url":"enums/parameterlocation.html#file","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":12,"kind":16,"name":"BODY_FORM","url":"enums/parameterlocation.html#body_form","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":13,"kind":16,"name":"BODY","url":"enums/parameterlocation.html#body","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":14,"kind":16,"name":"BODY_JSON","url":"enums/parameterlocation.html#body_json","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":15,"kind":16,"name":"BODY_XML","url":"enums/parameterlocation.html#body_xml","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":16,"kind":16,"name":"COOKIE","url":"enums/parameterlocation.html#cookie","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterLocation"},{"id":17,"kind":4,"name":"ParameterType","url":"enums/parametertype.html","classes":"tsd-kind-enum"},{"id":18,"kind":16,"name":"GENERIC_STRING","url":"enums/parametertype.html#generic_string","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":19,"kind":16,"name":"EMAIL","url":"enums/parametertype.html#email","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":20,"kind":16,"name":"URI","url":"enums/parametertype.html#uri","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":21,"kind":16,"name":"BOOL","url":"enums/parametertype.html#bool","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":22,"kind":16,"name":"INT","url":"enums/parametertype.html#int","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":23,"kind":16,"name":"FLOAT","url":"enums/parametertype.html#float","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":24,"kind":16,"name":"DOUBLE","url":"enums/parametertype.html#double","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":25,"kind":16,"name":"DATE","url":"enums/parametertype.html#date","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":26,"kind":16,"name":"DATETIME","url":"enums/parametertype.html#datetime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":27,"kind":16,"name":"TIME","url":"enums/parametertype.html#time","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":28,"kind":16,"name":"BASE64","url":"enums/parametertype.html#base64","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":29,"kind":16,"name":"IPV4","url":"enums/parametertype.html#ipv4","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":30,"kind":16,"name":"IPV6","url":"enums/parametertype.html#ipv6","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":31,"kind":16,"name":"HOSTNAME","url":"enums/parametertype.html#hostname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":32,"kind":16,"name":"UUID","url":"enums/parametertype.html#uuid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"ParameterType"},{"id":33,"kind":128,"name":"OperationRequest","url":"classes/operationrequest.html","classes":"tsd-kind-class"},{"id":34,"kind":512,"name":"constructor","url":"classes/operationrequest.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OperationRequest"},{"id":35,"kind":2048,"name":"getExtra","url":"classes/operationrequest.html#getextra","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":36,"kind":2048,"name":"setExtra","url":"classes/operationrequest.html#setextra","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":37,"kind":2048,"name":"getHeaders","url":"classes/operationrequest.html#getheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":38,"kind":2048,"name":"setHeaders","url":"classes/operationrequest.html#setheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":39,"kind":2048,"name":"getParams","url":"classes/operationrequest.html#getparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":40,"kind":2048,"name":"setParams","url":"classes/operationrequest.html#setparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":41,"kind":2048,"name":"getUser","url":"classes/operationrequest.html#getuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":42,"kind":2048,"name":"setUser","url":"classes/operationrequest.html#setuser","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationRequest"},{"id":43,"kind":128,"name":"OperationResponse","url":"classes/operationresponse.html","classes":"tsd-kind-class"},{"id":44,"kind":512,"name":"constructor","url":"classes/operationresponse.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OperationResponse"},{"id":45,"kind":2048,"name":"getHeaders","url":"classes/operationresponse.html#getheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":46,"kind":2048,"name":"setHeaders","url":"classes/operationresponse.html#setheaders","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":47,"kind":2048,"name":"getPayload","url":"classes/operationresponse.html#getpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":48,"kind":2048,"name":"setPayload","url":"classes/operationresponse.html#setpayload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":49,"kind":2048,"name":"getStatusCode","url":"classes/operationresponse.html#getstatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":50,"kind":2048,"name":"setStatusCode","url":"classes/operationresponse.html#setstatuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":51,"kind":2048,"name":"getStatusMessage","url":"classes/operationresponse.html#getstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":52,"kind":2048,"name":"setStatusMessage","url":"classes/operationresponse.html#setstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OperationResponse"},{"id":53,"kind":128,"name":"RouterFactoryOptions","url":"classes/routerfactoryoptions.html","classes":"tsd-kind-class"},{"id":54,"kind":512,"name":"constructor","url":"classes/routerfactoryoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":55,"kind":2048,"name":"isMountNotImplementedHandler","url":"classes/routerfactoryoptions.html#ismountnotimplementedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":56,"kind":2048,"name":"setMountNotImplementedHandler","url":"classes/routerfactoryoptions.html#setmountnotimplementedhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":57,"kind":2048,"name":"isMountResponseContentTypeHandler","url":"classes/routerfactoryoptions.html#ismountresponsecontenttypehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":58,"kind":2048,"name":"setMountResponseContentTypeHandler","url":"classes/routerfactoryoptions.html#setmountresponsecontenttypehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":59,"kind":2048,"name":"isMountValidationFailureHandler","url":"classes/routerfactoryoptions.html#ismountvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":60,"kind":2048,"name":"setMountValidationFailureHandler","url":"classes/routerfactoryoptions.html#setmountvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":61,"kind":2048,"name":"getOperationModelKey","url":"classes/routerfactoryoptions.html#getoperationmodelkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":62,"kind":2048,"name":"setOperationModelKey","url":"classes/routerfactoryoptions.html#setoperationmodelkey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":63,"kind":2048,"name":"isRequireSecurityHandlers","url":"classes/routerfactoryoptions.html#isrequiresecurityhandlers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":64,"kind":2048,"name":"setRequireSecurityHandlers","url":"classes/routerfactoryoptions.html#setrequiresecurityhandlers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RouterFactoryOptions"},{"id":65,"kind":128,"name":"ContainerDeserializer","url":"classes/containerdeserializer.html","classes":"tsd-kind-class"},{"id":66,"kind":2048,"name":"deserializeArray","url":"classes/containerdeserializer.html#deserializearray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ContainerDeserializer"},{"id":67,"kind":2048,"name":"deserializeObject","url":"classes/containerdeserializer.html#deserializeobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ContainerDeserializer"},{"id":68,"kind":128,"name":"CustomValidator","url":"classes/customvalidator.html","classes":"tsd-kind-class"},{"id":69,"kind":2048,"name":"validate","url":"classes/customvalidator.html#validate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"CustomValidator"},{"id":70,"kind":256,"name":"HTTPOperationRequestValidationHandler","url":"interfaces/httpoperationrequestvalidationhandler.html","classes":"tsd-kind-interface"},{"id":71,"kind":2048,"name":"handle","url":"interfaces/httpoperationrequestvalidationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HTTPOperationRequestValidationHandler"},{"id":72,"kind":2048,"name":"parseOperationSpec","url":"interfaces/httpoperationrequestvalidationhandler.html#parseoperationspec","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"HTTPOperationRequestValidationHandler"},{"id":73,"kind":128,"name":"HTTPRequestValidationHandler","url":"classes/httprequestvalidationhandler.html","classes":"tsd-kind-class"},{"id":74,"kind":2048,"name":"handle","url":"classes/httprequestvalidationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":75,"kind":2048,"name":"create","url":"classes/httprequestvalidationhandler.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"HTTPRequestValidationHandler"},{"id":76,"kind":2048,"name":"addPathParam","url":"classes/httprequestvalidationhandler.html#addpathparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":77,"kind":2048,"name":"addPathParamWithPattern","url":"classes/httprequestvalidationhandler.html#addpathparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":78,"kind":2048,"name":"addPathParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addpathparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":79,"kind":2048,"name":"addQueryParam","url":"classes/httprequestvalidationhandler.html#addqueryparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":80,"kind":2048,"name":"addQueryParamWithPattern","url":"classes/httprequestvalidationhandler.html#addqueryparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":81,"kind":2048,"name":"addQueryParamsArray","url":"classes/httprequestvalidationhandler.html#addqueryparamsarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":82,"kind":2048,"name":"addQueryParamsArrayWithPattern","url":"classes/httprequestvalidationhandler.html#addqueryparamsarraywithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":83,"kind":2048,"name":"addQueryParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addqueryparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":84,"kind":2048,"name":"addHeaderParam","url":"classes/httprequestvalidationhandler.html#addheaderparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":85,"kind":2048,"name":"addHeaderParamWithPattern","url":"classes/httprequestvalidationhandler.html#addheaderparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":86,"kind":2048,"name":"addHeaderParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addheaderparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":87,"kind":2048,"name":"addFormParam","url":"classes/httprequestvalidationhandler.html#addformparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":88,"kind":2048,"name":"addFormParamWithPattern","url":"classes/httprequestvalidationhandler.html#addformparamwithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":89,"kind":2048,"name":"addFormParamsArray","url":"classes/httprequestvalidationhandler.html#addformparamsarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":90,"kind":2048,"name":"addFormParamsArrayWithPattern","url":"classes/httprequestvalidationhandler.html#addformparamsarraywithpattern","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":91,"kind":2048,"name":"addFormParamWithCustomTypeValidator","url":"classes/httprequestvalidationhandler.html#addformparamwithcustomtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":92,"kind":2048,"name":"addCustomValidatorFunction","url":"classes/httprequestvalidationhandler.html#addcustomvalidatorfunction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":93,"kind":2048,"name":"addJsonBodySchema","url":"classes/httprequestvalidationhandler.html#addjsonbodyschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":94,"kind":2048,"name":"addXMLBodySchema","url":"classes/httprequestvalidationhandler.html#addxmlbodyschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":95,"kind":2048,"name":"addMultipartRequiredFile","url":"classes/httprequestvalidationhandler.html#addmultipartrequiredfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":96,"kind":2048,"name":"addExpectedContentType","url":"classes/httprequestvalidationhandler.html#addexpectedcontenttype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HTTPRequestValidationHandler"},{"id":97,"kind":128,"name":"OpenAPI3RequestValidationHandler","url":"classes/openapi3requestvalidationhandler.html","classes":"tsd-kind-class"},{"id":98,"kind":2048,"name":"handle","url":"classes/openapi3requestvalidationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RequestValidationHandler"},{"id":99,"kind":2048,"name":"parseOperationSpec","url":"classes/openapi3requestvalidationhandler.html#parseoperationspec","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RequestValidationHandler"},{"id":100,"kind":128,"name":"OpenAPI3RouterFactory","url":"classes/openapi3routerfactory.html","classes":"tsd-kind-class"},{"id":101,"kind":2048,"name":"addSecurityHandler","url":"classes/openapi3routerfactory.html#addsecurityhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":102,"kind":2048,"name":"setOptions","url":"classes/openapi3routerfactory.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":103,"kind":2048,"name":"getOptions","url":"classes/openapi3routerfactory.html#getoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":104,"kind":2048,"name":"getRouter","url":"classes/openapi3routerfactory.html#getrouter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":105,"kind":2048,"name":"getValidationFailureHandler","url":"classes/openapi3routerfactory.html#getvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":106,"kind":2048,"name":"setValidationFailureHandler","url":"classes/openapi3routerfactory.html#setvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":107,"kind":2048,"name":"setNotImplementedFailureHandler","url":"classes/openapi3routerfactory.html#setnotimplementedfailurehandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":108,"kind":2048,"name":"setBodyHandler","url":"classes/openapi3routerfactory.html#setbodyhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":109,"kind":2048,"name":"addGlobalHandler","url":"classes/openapi3routerfactory.html#addglobalhandler","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":110,"kind":2048,"name":"setExtraOperationContextPayloadMapper","url":"classes/openapi3routerfactory.html#setextraoperationcontextpayloadmapper","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":111,"kind":2048,"name":"addSecuritySchemaScopeValidator","url":"classes/openapi3routerfactory.html#addsecurityschemascopevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":112,"kind":2048,"name":"addHandlerByOperationId","url":"classes/openapi3routerfactory.html#addhandlerbyoperationid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":113,"kind":2048,"name":"addFailureHandlerByOperationId","url":"classes/openapi3routerfactory.html#addfailurehandlerbyoperationid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":114,"kind":2048,"name":"mountOperationToEventBus","url":"classes/openapi3routerfactory.html#mountoperationtoeventbus","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":115,"kind":2048,"name":"mountServiceFromTag","url":"classes/openapi3routerfactory.html#mountservicefromtag","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":116,"kind":2048,"name":"mountServicesFromExtensions","url":"classes/openapi3routerfactory.html#mountservicesfromextensions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenAPI3RouterFactory"},{"id":117,"kind":2048,"name":"create","url":"classes/openapi3routerfactory.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"OpenAPI3RouterFactory"},{"id":118,"kind":128,"name":"ParameterTypeValidator","url":"classes/parametertypevalidator.html","classes":"tsd-kind-class"},{"id":119,"kind":2048,"name":"isValid","url":"classes/parametertypevalidator.html#isvalid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":120,"kind":2048,"name":"isValidCollection","url":"classes/parametertypevalidator.html#isvalidcollection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":121,"kind":2048,"name":"getDefault","url":"classes/parametertypevalidator.html#getdefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":122,"kind":2048,"name":"hasDefault","url":"classes/parametertypevalidator.html#hasdefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterTypeValidator"},{"id":123,"kind":2048,"name":"createIntegerTypeValidator","url":"classes/parametertypevalidator.html#createintegertypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":124,"kind":2048,"name":"createLongTypeValidator","url":"classes/parametertypevalidator.html#createlongtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":125,"kind":2048,"name":"createFloatTypeValidator","url":"classes/parametertypevalidator.html#createfloattypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":126,"kind":2048,"name":"createDoubleTypeValidator","url":"classes/parametertypevalidator.html#createdoubletypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":127,"kind":2048,"name":"createStringTypeValidator","url":"classes/parametertypevalidator.html#createstringtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":128,"kind":2048,"name":"createBooleanTypeValidator","url":"classes/parametertypevalidator.html#createbooleantypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":129,"kind":2048,"name":"createStringEnumTypeValidator","url":"classes/parametertypevalidator.html#createstringenumtypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":130,"kind":2048,"name":"createEnumTypeValidatorWithInnerValidator","url":"classes/parametertypevalidator.html#createenumtypevalidatorwithinnervalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":131,"kind":2048,"name":"createArrayTypeValidator","url":"classes/parametertypevalidator.html#createarraytypevalidator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ParameterTypeValidator"},{"id":132,"kind":128,"name":"ParameterValidationRule","url":"classes/parametervalidationrule.html","classes":"tsd-kind-class"},{"id":133,"kind":2048,"name":"getName","url":"classes/parametervalidationrule.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":134,"kind":2048,"name":"validateSingleParam","url":"classes/parametervalidationrule.html#validatesingleparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":135,"kind":2048,"name":"validateArrayParam","url":"classes/parametervalidationrule.html#validatearrayparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":136,"kind":2048,"name":"isOptional","url":"classes/parametervalidationrule.html#isoptional","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":137,"kind":2048,"name":"parameterTypeValidator","url":"classes/parametervalidationrule.html#parametertypevalidator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":138,"kind":2048,"name":"allowEmptyValue","url":"classes/parametervalidationrule.html#allowemptyvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ParameterValidationRule"},{"id":139,"kind":128,"name":"RequestParameter","url":"classes/requestparameter.html","classes":"tsd-kind-class"},{"id":140,"kind":2048,"name":"setName","url":"classes/requestparameter.html#setname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":141,"kind":2048,"name":"setValue","url":"classes/requestparameter.html#setvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":142,"kind":2048,"name":"getName","url":"classes/requestparameter.html#getname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":143,"kind":2048,"name":"getObjectKeys","url":"classes/requestparameter.html#getobjectkeys","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":144,"kind":2048,"name":"getObjectValue","url":"classes/requestparameter.html#getobjectvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":145,"kind":2048,"name":"isObject","url":"classes/requestparameter.html#isobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":146,"kind":2048,"name":"getArray","url":"classes/requestparameter.html#getarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":147,"kind":2048,"name":"isArray","url":"classes/requestparameter.html#isarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":148,"kind":2048,"name":"getString","url":"classes/requestparameter.html#getstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":149,"kind":2048,"name":"isString","url":"classes/requestparameter.html#isstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":150,"kind":2048,"name":"getInteger","url":"classes/requestparameter.html#getinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":151,"kind":2048,"name":"isInteger","url":"classes/requestparameter.html#isinteger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":152,"kind":2048,"name":"getLong","url":"classes/requestparameter.html#getlong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":153,"kind":2048,"name":"isLong","url":"classes/requestparameter.html#islong","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":154,"kind":2048,"name":"getFloat","url":"classes/requestparameter.html#getfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":155,"kind":2048,"name":"isFloat","url":"classes/requestparameter.html#isfloat","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":156,"kind":2048,"name":"getDouble","url":"classes/requestparameter.html#getdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":157,"kind":2048,"name":"isDouble","url":"classes/requestparameter.html#isdouble","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":158,"kind":2048,"name":"getBoolean","url":"classes/requestparameter.html#getboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":159,"kind":2048,"name":"isBoolean","url":"classes/requestparameter.html#isboolean","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":160,"kind":2048,"name":"getJsonObject","url":"classes/requestparameter.html#getjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":161,"kind":2048,"name":"isJsonObject","url":"classes/requestparameter.html#isjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":162,"kind":2048,"name":"getJsonArray","url":"classes/requestparameter.html#getjsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":163,"kind":2048,"name":"isJsonArray","url":"classes/requestparameter.html#isjsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":164,"kind":2048,"name":"isNull","url":"classes/requestparameter.html#isnull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":165,"kind":2048,"name":"isEmpty","url":"classes/requestparameter.html#isempty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":166,"kind":2048,"name":"toJson","url":"classes/requestparameter.html#tojson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":167,"kind":2048,"name":"merge","url":"classes/requestparameter.html#merge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameter"},{"id":168,"kind":2048,"name":"create","url":"classes/requestparameter.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RequestParameter"},{"id":169,"kind":128,"name":"RequestParameters","url":"classes/requestparameters.html","classes":"tsd-kind-class"},{"id":170,"kind":2048,"name":"pathParametersNames","url":"classes/requestparameters.html#pathparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":171,"kind":2048,"name":"pathParameter","url":"classes/requestparameters.html#pathparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":172,"kind":2048,"name":"queryParametersNames","url":"classes/requestparameters.html#queryparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":173,"kind":2048,"name":"queryParameter","url":"classes/requestparameters.html#queryparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":174,"kind":2048,"name":"headerParametersNames","url":"classes/requestparameters.html#headerparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":175,"kind":2048,"name":"headerParameter","url":"classes/requestparameters.html#headerparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":176,"kind":2048,"name":"cookieParametersNames","url":"classes/requestparameters.html#cookieparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":177,"kind":2048,"name":"cookieParameter","url":"classes/requestparameters.html#cookieparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":178,"kind":2048,"name":"formParametersNames","url":"classes/requestparameters.html#formparametersnames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":179,"kind":2048,"name":"formParameter","url":"classes/requestparameters.html#formparameter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":180,"kind":2048,"name":"body","url":"classes/requestparameters.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":181,"kind":2048,"name":"toJson","url":"classes/requestparameters.html#tojson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RequestParameters"},{"id":182,"kind":256,"name":"RouterFactory","url":"interfaces/routerfactory.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":183,"kind":2048,"name":"addSecurityHandler","url":"interfaces/routerfactory.html#addsecurityhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":184,"kind":2048,"name":"setOptions","url":"interfaces/routerfactory.html#setoptions","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":185,"kind":2048,"name":"getOptions","url":"interfaces/routerfactory.html#getoptions","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":186,"kind":2048,"name":"getRouter","url":"interfaces/routerfactory.html#getrouter","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":187,"kind":2048,"name":"getValidationFailureHandler","url":"interfaces/routerfactory.html#getvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":188,"kind":2048,"name":"setValidationFailureHandler","url":"interfaces/routerfactory.html#setvalidationfailurehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":189,"kind":2048,"name":"setNotImplementedFailureHandler","url":"interfaces/routerfactory.html#setnotimplementedfailurehandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":190,"kind":2048,"name":"setBodyHandler","url":"interfaces/routerfactory.html#setbodyhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":191,"kind":2048,"name":"addGlobalHandler","url":"interfaces/routerfactory.html#addglobalhandler","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":192,"kind":2048,"name":"setExtraOperationContextPayloadMapper","url":"interfaces/routerfactory.html#setextraoperationcontextpayloadmapper","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RouterFactory"},{"id":193,"kind":256,"name":"ValidationHandler","url":"interfaces/validationhandler.html","classes":"tsd-kind-interface"},{"id":194,"kind":2048,"name":"handle","url":"interfaces/validationhandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ValidationHandler"}]}; \ No newline at end of file diff --git a/docs/@vertx/web-api-contract/classes/containerdeserializer.html b/docs/@vertx/web-api-contract/classes/containerdeserializer.html index 6354d6493..66e09dc98 100644 --- a/docs/@vertx/web-api-contract/classes/containerdeserializer.html +++ b/docs/@vertx/web-api-contract/classes/containerdeserializer.html @@ -98,7 +98,7 @@

    deserializeArray

  • Parameters

    @@ -121,7 +121,7 @@

    deserializeObject

  • Parameters

    @@ -154,9 +154,6 @@
    [key: ContainerSerializationStyle
    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -190,6 +187,12 @@
    [key: OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -208,7 +211,7 @@
    [key: HTTPOperationRequestValidationHandler -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/classes/customvalidator.html b/docs/@vertx/web-api-contract/classes/customvalidator.html index f55e228ca..1474421a7 100644 --- a/docs/@vertx/web-api-contract/classes/customvalidator.html +++ b/docs/@vertx/web-api-contract/classes/customvalidator.html @@ -97,12 +97,12 @@

    validate

  • -

    This function have to be synchronous. It doesn't return nothing if validation succedes, otherwise it +

    This function have to be synchronous. It doesn't return nothing if validation succedes, otherwise it throws ValidationException.
    Don't call routingContext.next() or routingContext.fail() from this function

    @@ -141,9 +141,6 @@

    Returns void ContainerSerializationStyle

    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -174,6 +171,12 @@

    Returns void OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -192,7 +195,7 @@

    Returns void HTTPOperationRequestValidationHandler -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/classes/httprequestvalidationhandler.html b/docs/@vertx/web-api-contract/classes/httprequestvalidationhandler.html index 50c9293a1..1d1a79e67 100644 --- a/docs/@vertx/web-api-contract/classes/httprequestvalidationhandler.html +++ b/docs/@vertx/web-api-contract/classes/httprequestvalidationhandler.html @@ -72,6 +72,13 @@

    Hierarchy

    • +
    +

    Implements

    + +

    Index

    @@ -119,12 +126,12 @@

    addCustomValidatorFunction

  • -

    Add a custom validator. For more informations about custom validator, see CustomValidator

    +

    Add a custom validator. For more informations about custom validator, see CustomValidator

    Parameters

    @@ -148,12 +155,12 @@

    addExpectedContentType

  • -

    Add an expected content type of request. It's not needed to add application/json, application/xml, +

    Add an expected content type of request. It's not needed to add application/json, application/xml, multipart/form-data and application/x-www-form-urlencoded

    @@ -181,12 +188,12 @@

    addFormParam

  • -

    Add a single parameter inside a form with included parameter types

    +

    Add a single parameter inside a form with included parameter types

    Parameters

    @@ -225,12 +232,12 @@

    addFormParamWithCustomTypeValidator

  • -

    Add a form parameter with a custom type validator. For more informations about how to construct built-in or +

    Add a form parameter with a custom type validator. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator

    @@ -277,12 +284,12 @@

    addFormParamWithPattern

  • -

    Add a single parameter inside a form with a custom pattern

    +

    Add a single parameter inside a form with a custom pattern

    Parameters

    @@ -321,12 +328,12 @@

    addFormParamsArray

  • -

    Add a form parameters array with included parameter types

    +

    Add a form parameters array with included parameter types

    Parameters

    @@ -365,12 +372,12 @@

    addFormParamsArrayWithPattern

  • -

    Add a form parameters array with a custom pattern

    +

    Add a form parameters array with a custom pattern

    Parameters

    @@ -409,12 +416,12 @@

    addHeaderParam

  • -

    Add a header parameter with included parameter types

    +

    Add a header parameter with included parameter types

    Parameters

    @@ -453,12 +460,12 @@

    addHeaderParamWithCustomTypeValidator

  • -

    Add a header parameter with a custom type validator. For more informations about how to construct built-in or +

    Add a header parameter with a custom type validator. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator

    @@ -505,12 +512,12 @@

    addHeaderParamWithPattern

  • -

    Add a header parameter with a custom pattern

    +

    Add a header parameter with a custom pattern

    Parameters

    @@ -549,12 +556,12 @@

    addJsonBodySchema

  • -

    Add a json schema for body with Content-Type "application/json"

    +

    Add a json schema for body with Content-Type "application/json"

    Parameters

    @@ -578,12 +585,12 @@

    addMultipartRequiredFile

  • -

    Add an expected filename inside multipart request.

    +

    Add an expected filename inside multipart request.

    Parameters

    @@ -616,12 +623,12 @@

    addPathParam

  • -

    Add a path parameter with included parameter types. All path params are required

    +

    Add a path parameter with included parameter types. All path params are required

    Parameters

    @@ -654,12 +661,12 @@

    addPathParamWithCustomTypeValidator

  • -

    Add a path parameter with a custom type validator. All path params are required. For more informations +

    Add a path parameter with a custom type validator. All path params are required. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator

    @@ -700,12 +707,12 @@

    addPathParamWithPattern

  • -

    Add a path parameter with a custom pattern. All path params are required

    +

    Add a path parameter with a custom pattern. All path params are required

    Parameters

    @@ -738,12 +745,12 @@

    addQueryParam

  • -

    Add a query parameter with included parameter types

    +

    Add a query parameter with included parameter types

    Parameters

    @@ -782,12 +789,12 @@

    addQueryParamWithCustomTypeValidator

  • -

    Add a query parameter with a custom type validator. For more informations about how to construct built-in or +

    Add a query parameter with a custom type validator. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator

    @@ -834,12 +841,12 @@

    addQueryParamWithPattern

  • -

    Add a query parameter with a custom pattern

    +

    Add a query parameter with a custom pattern

    Parameters

    @@ -878,12 +885,12 @@

    addQueryParamsArray

  • -

    Add a query parameters array with included parameter types

    +

    Add a query parameters array with included parameter types

    Parameters

    @@ -922,12 +929,12 @@

    addQueryParamsArrayWithPattern

  • -

    Add a query parameters array with a custom pattern

    +

    Add a query parameters array with a custom pattern

    Parameters

    @@ -966,12 +973,12 @@

    addXMLBodySchema

  • -

    Add a xml schema for body with Content-Type "application/xml"

    +

    Add a xml schema for body with Content-Type "application/xml"

    Parameters

    @@ -994,8 +1001,9 @@

    handle

    • +
    +

    Implements

    + +

    Index

    @@ -97,8 +104,9 @@

    handle

    +
    +

    Implements

    + +

    Index

    @@ -79,21 +85,23 @@

    Index

    Methods

    @@ -101,60 +109,6 @@

    Methods

    Methods

    -
    - -

    addFailureHandler

    -
      -
    • addFailureHandler(method: HttpMethod, path: string, failureHandler: function): RouterFactory
      • -
    -
      -
    • - -
      -
      -

      Add a failure handler to a path with a method. If combination path/method is not available in - specification, it will throw a {@link RouterFactoryException}. Deprecated in favour of - operation id

      -
      -
      -

      Parameters

      -
        -
      • -
        method: HttpMethod
        -
        • -
      • -
        path: string
        -
        • -
      • -
        failureHandler: function
        -
          -
        • -
            -
          • (result: RoutingContext): void
            • -
          -
            -
          • -

            Parameters

            -
              -
            • -
              result: RoutingContext
              -
              • -
            -

            Returns void

            -
            • -
          -
          • -
        -
        • -
      -

      Returns RouterFactory

      -
      • -
    -

    addFailureHandlerByOperationId

    @@ -165,12 +119,12 @@

    addFailureHandlerByOperationId

  • -

    Add a failure handler by operation_id field in Operation object

    +

    Add a failure handler by operation_id field in Operation object

    Parameters

    @@ -183,17 +137,20 @@
    failureHandler: function
      • -
      • (result: RoutingContext): void
        • +
      • (res: RoutingContext): void | Handler<RoutingContext>

      • Parameters

        • -
          result: RoutingContext
          +
          res: RoutingContext
        -

        Returns void

        +

        Returns void + | + Handler<RoutingContext> +

      • @@ -206,56 +163,53 @@

      Returns

    • - -

    addHandler

    + +

    addGlobalHandler

      -
    • addHandler(method: HttpMethod, path: string, handler: function): RouterFactory
      • +
    • addGlobalHandler(globalHandler: function): RouterFactory<any>
    • -

      Add an handler to a path with a method. If combination path/method is not available in - specification, it will throw a {@link RouterFactoryException}. Deprecated in favour of - operation id

      +

      Add global handler to be applied prior to {@link io.vertx.ext.web.Router} being generated.
      + Please note that you should not add a body handler inside that list. If you want to modify the body handler, please use {@link RouterFactory#setBodyHandler(BodyHandler)}

      Parameters

      • -
        method: HttpMethod
        -
        • -
      • -
        path: string
        -
        • -
      • -
        handler: function
        +
        globalHandler: function
          • -
          • (result: RoutingContext): void
            • +
          • (res: RoutingContext): void | Handler<RoutingContext>

          • Parameters

            • -
              result: RoutingContext
              +
              res: RoutingContext
            -

            Returns void

            +

            Returns void + | + Handler<RoutingContext> +

      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

      +

      this object

    @@ -269,12 +223,12 @@

    addHandlerByOperationId

  • -

    Add an handler by operation_id field in Operation object

    +

    Add an handler by operation_id field in Operation object

    Parameters

    @@ -287,17 +241,20 @@
    handler: function
      • -
      • (result: RoutingContext): void
        • +
      • (res: RoutingContext): void | Handler<RoutingContext>

      • Parameters

        • -
          result: RoutingContext
          +
          res: RoutingContext
        -

        Returns void

        +

        Returns void + | + Handler<RoutingContext> +

      • @@ -313,18 +270,18 @@

      Returns

      addSecurityHandler

        -
      • addSecurityHandler(securitySchemaName: string, handler: function): RouterFactory
        • +
      • addSecurityHandler(securitySchemaName: string, handler: function): RouterFactory<any>
      • -

        Mount to paths that have to follow a security schema a security handler

        +

        Mount to paths that have to follow a security schema a security handler

        Parameters

        @@ -337,24 +294,27 @@
        handler: function
          • -
          • (result: RoutingContext): void
            • +
          • (res: RoutingContext): void | Handler<RoutingContext>

          • Parameters

            • -
              result: RoutingContext
              +
              res: RoutingContext
            -

            Returns void

            +

            Returns void + | + Handler<RoutingContext> +

      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

    • @@ -368,12 +328,12 @@

    addSecuritySchemaScopeValidator

  • -

    Add a particular scope validator. The main security schema will not be called if a specific scope validator is +

    Add a particular scope validator. The main security schema will not be called if a specific scope validator is configured

    @@ -390,17 +350,20 @@
    handler: function
      • -
      • (result: RoutingContext): void
        • +
      • (res: RoutingContext): void | Handler<RoutingContext>

      • Parameters

        • -
          result: RoutingContext
          +
          res: RoutingContext
        -

        Returns void

        +

        Returns void + | + Handler<RoutingContext> +

      • @@ -413,261 +376,411 @@

      Returns

    • - -

    enableValidationFailureHandler

    + +

    getOptions

    + + +
    +
    + +

    getRouter

      -
    • enableValidationFailureHandler(enable: boolean): RouterFactory
      • +
    • getRouter(): Router
    • -

      Deprecated. Instantiate RouterFactoryOptions - and load it using {@link RouterFactory#setOptions(RouterFactoryOptions)}

      +

      Construct a new router based on spec. It will fail if you are trying to mount a spec with security schemes + without assigned handlers
      + Note: Router is constructed in this function, so it will be respected the path definition ordering.

      +
      +
      +

      Returns Router

      +
      • +
    +
    +
    + +

    getValidationFailureHandler

    +
      +
    • getValidationFailureHandler(): function
      • +
    +
      +
    • + +

      Returns function

      +
        +
      • +
          +
        • (res: RoutingContext): void | Handler<RoutingContext>
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            res: RoutingContext
            +
            • +
          +

          Returns void + | + Handler<RoutingContext> +

          +
          • +
        +
        • +
      +
      • +
    +
    +
    + +

    mountOperationToEventBus

    + +
      +
    • + +
      +
      +

      Specify to route an incoming request for specified operation id to a Web Api Service mounted at the specified address on event bus. Please give a look at vertx-web-api-service documentation for more informations

      Parameters

      • -
        enable: boolean
        +
        operationId: string
        +
        • +
      • +
        address: string
      -

      Returns RouterFactory

      +

      Returns OpenAPI3RouterFactory

      +

      this factory

    - -

    getOptions

    + +

    mountServiceFromTag

    • -

      Get options of router factory. For more info RouterFactoryOptions

      +

      Specify to route an incoming request for all operations that contains the specified tag to a Web Api Service mounted at the specified address on event bus. + The request is handled by the method that matches the operation id. Please give a look at vertx-web-api-service documentation for more informations

      -

      Returns RouterFactoryOptions

      +

      Parameters

      +
        +
      • +
        tag: string
        +
        • +
      • +
        address: string
        +
        • +
      +

      Returns OpenAPI3RouterFactory

      +

      this factory

    - -

    getRouter

    + +

    mountServicesFromExtensions

    • -

      Construct a new router based on spec. It will fail if you are trying to mount a spec with security schemes - without assigned handlers
      - Note: Router is constructed in this function, so it will be respected the path definition ordering.

      +

      Introspect the OpenAPI spec to mount handlers for all operations that specifies a x-vertx-event-bus annotation. Please give a look at vertx-web-api-service documentation for more informations

      -

      Returns Router

      +

      Returns OpenAPI3RouterFactory

      +

      this factory

    - -

    mountOperationsWithoutHandlers

    + +

    setBodyHandler

    • -

      Deprecated. Instantiate RouterFactoryOptions - and load it using {@link RouterFactory#setOptions(RouterFactoryOptions)}

      +

      Supply your own BodyHandler if you would like to control body limit, uploads directory and deletion of uploaded files

      Parameters

      • -
        enable: boolean
        +
        bodyHandler: BodyHandler
      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

      +

      self

    - -

    setOptions

    + +

    setExtraOperationContextPayloadMapper

    • -

      Override options

      +

      When set, this function is called while creating the payload of {@link io.vertx.ext.web.api.OperationRequest}

      Parameters

      • -
        options: RouterFactoryOptions
        +
        extraOperationContextPayloadMapper: function
        +
          +
        • +
            +
          • (arg: RoutingContext): object
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              arg: RoutingContext
              +
              • +
            +

            Returns object

            +
              +
            • +
              [key: string]: any
              +
              • +
            +
            • +
          +
          • +
      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

    - -

    setValidationFailureHandler

    + +

    setNotImplementedFailureHandler

      -
    • setValidationFailureHandler(handler: function): RouterFactory
      • +
    • setNotImplementedFailureHandler(notImplementedFailureHandler: function): RouterFactory<any>
    • -

      Deprecated. Instantiate RouterFactoryOptions - and load it using {@link RouterFactory#setOptions(RouterFactoryOptions)}

      +

      Set not implemented failure handler. It's called when you don't define an handler for a + specific operation. You can enable/disable this feature from + {@link RouterFactoryOptions#setMountNotImplementedHandler(boolean)}

      Parameters

      • -
        handler: function
        +
        notImplementedFailureHandler: function
          • -
          • (result: RoutingContext): void
            • +
          • (res: RoutingContext): void | Handler<RoutingContext>

          • Parameters

            • -
              result: RoutingContext
              +
              res: RoutingContext
            -

            Returns void

            +

            Returns void + | + Handler<RoutingContext> +

      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

      +

      this object

    -
    - -

    Static create

    -
    • @@ -1113,7 +1116,7 @@

      Returns HTTPOperationRequestValidationHandler

      • -
    • +
    • RouterFactory
    • diff --git a/docs/@vertx/web-api-contract/classes/parametervalidationrule.html b/docs/@vertx/web-api-contract/classes/parametervalidationrule.html index ee4924006..c1cfb9677 100644 --- a/docs/@vertx/web-api-contract/classes/parametervalidationrule.html +++ b/docs/@vertx/web-api-contract/classes/parametervalidationrule.html @@ -102,12 +102,12 @@

      allowEmptyValue

    • -

      allowEmptyValue is used in query, header, cookie and form parameters. This is its behaviour: +

      allowEmptyValue is used in query, header, cookie and form parameters. This is its behaviour:

      1. During validation, the ValidationHandler check if there's a parameter with combination of location and name as defined in this rule
        2. @@ -142,12 +142,12 @@

        getName

      2. -

        This function return the name of the parameter expected into parameter lists

        +

        This function return the name of the parameter expected into parameter lists

        Returns string

        @@ -165,12 +165,12 @@

        isOptional

      3. -

        Return true if parameter is optional

        +

        Return true if parameter is optional

        Returns boolean

        @@ -188,12 +188,12 @@

        parameterTypeValidator

      4. -

        Return ParameterTypeValidator instance used inside this parameter validation rule

        +

        Return ParameterTypeValidator instance used inside this parameter validation rule

        Returns ParameterTypeValidator

        @@ -210,12 +210,12 @@

        validateArrayParam

      5. -

        This function will be called when there is a List that need to be validated. It must check if array is +

        This function will be called when there is a List that need to be validated. It must check if array is expected or not. It will throw a ValidationError in an error during validation occurs

        @@ -247,12 +247,12 @@

        validateSingleParam

      6. -

        This function will be called when there is only a string as parameter. It will throw a ValidationError in an +

        This function will be called when there is only a string as parameter. It will throw a ValidationError in an error during validation occurs

        @@ -289,9 +289,6 @@

        Returns ContainerSerializationStyle

        7. -
      7. - ErrorType -
      8. ParameterLocation
        9. @@ -313,6 +310,12 @@

        Returns OpenAPI3RouterFactory

        9. +
      9. + OperationRequest +
        10. +
      10. + OperationResponse +
      11. ParameterTypeValidator
        12. @@ -355,7 +358,7 @@

        Returns HTTPOperationRequestValidationHandler -
      12. +
      13. RouterFactory
      14. diff --git a/docs/@vertx/web-api-contract/classes/requestparameter.html b/docs/@vertx/web-api-contract/classes/requestparameter.html index 8a93b3a06..05565818f 100644 --- a/docs/@vertx/web-api-contract/classes/requestparameter.html +++ b/docs/@vertx/web-api-contract/classes/requestparameter.html @@ -106,6 +106,7 @@

        Methods

      15. merge
      16. setName
      17. setValue
        18. +
      18. toJson
      19. create

    @@ -124,12 +125,12 @@

    getArray

  • -

    Returns null if value is not a list, otherwise it returns value

    +

    Returns null if value is not a list, otherwise it returns value

    Returns RequestParameter[] @@ -149,12 +150,12 @@

    getBoolean

  • -

    Returns null if value is not a Boolean, otherwise it returns value

    +

    Returns null if value is not a Boolean, otherwise it returns value

    Returns boolean @@ -174,12 +175,12 @@

    getDouble

  • -

    Returns null if value is not a Double, otherwise it returns value

    +

    Returns null if value is not a Double, otherwise it returns value

    Returns number @@ -199,12 +200,12 @@

    getFloat

  • -

    Returns null if value is not a Float, otherwise it returns value

    +

    Returns null if value is not a Float, otherwise it returns value

    Returns number @@ -224,12 +225,12 @@

    getInteger

  • -

    Returns null if value is not an Integer, otherwise it returns value

    +

    Returns null if value is not an Integer, otherwise it returns value

    Returns number @@ -249,12 +250,12 @@

    getJsonArray

  • -

    Returns null if value is not a JsonArray, otherwise it returns value

    +

    Returns null if value is not a JsonArray, otherwise it returns value

    Returns any[] @@ -268,21 +269,21 @@

    Returns any

    getJsonObject

      -
    • getJsonObject(): any | null
      • +
    • getJsonObject(): object | null
    • -

      Returns null if value is not a JsonObject, otherwise it returns value

      +

      Returns null if value is not a JsonObject, otherwise it returns value

      -

      Returns any +

      Returns object | null

      @@ -299,12 +300,12 @@

      getLong

    • -

      Returns null if value is not a Long, otherwise it returns value

      +

      Returns null if value is not a Long, otherwise it returns value

      Returns number @@ -324,12 +325,12 @@

      getName

    • -

      Get parameter name

      +

      Get parameter name

      Returns string @@ -349,12 +350,12 @@

      getObjectKeys

    • -

      If value is a map of fields, it returns keys of map, otherwise it returns null

      +

      If value is a map of fields, it returns keys of map, otherwise it returns null

      Returns string[] @@ -374,12 +375,12 @@

      getObjectValue

    • -

      If value is a map of fields, it returns value of field with key provided, otherwise it returns null

      +

      If value is a map of fields, it returns value of field with key provided, otherwise it returns null

      Parameters

      @@ -405,12 +406,12 @@

      getString

    • -

      Returns null if value is not a String, otherwise it returns value

      +

      Returns null if value is not a String, otherwise it returns value

      Returns string @@ -430,12 +431,12 @@

      isArray

    • -

      Returns true if value of RequestParameter is an array

      +

      Returns true if value of RequestParameter is an array

      Returns boolean

      @@ -452,12 +453,12 @@

      isBoolean

    • -

      Returns true if value of RequestParameter is a Boolean instance

      +

      Returns true if value of RequestParameter is a Boolean instance

      Returns boolean

      @@ -474,12 +475,12 @@

      isDouble

    • -

      Returns true if value of RequestParameter is a Double instance

      +

      Returns true if value of RequestParameter is a Double instance

      Returns boolean

      @@ -496,12 +497,12 @@

      isEmpty

    • -

      Alias of {@link RequestParameter#isNull()}

      +

      Alias of {@link RequestParameter#isNull()}

      Returns boolean

      @@ -518,12 +519,12 @@

      isFloat

    • -

      Returns true if value of RequestParameter is a Float instance

      +

      Returns true if value of RequestParameter is a Float instance

      Returns boolean

      @@ -540,12 +541,12 @@

      isInteger

    • -

      Returns true if value of RequestParameter is an Integer instance

      +

      Returns true if value of RequestParameter is an Integer instance

      Returns boolean

      @@ -562,12 +563,12 @@

      isJsonArray

    • -

      Returns true if value of RequestParameter is a JsonArray instance

      +

      Returns true if value of RequestParameter is a JsonArray instance

      Returns boolean

      @@ -584,12 +585,12 @@

      isJsonObject

    • -

      Returns true if value of RequestParameter is a JsonObject instance

      +

      Returns true if value of RequestParameter is a JsonObject instance

      Returns boolean

      @@ -606,12 +607,12 @@

      isLong

    • -

      Returns true if value of RequestParameter is a Long instance

      +

      Returns true if value of RequestParameter is a Long instance

      Returns boolean

      @@ -628,12 +629,12 @@

      isNull

    • -

      Returns true if value is null

      +

      Returns true if value is null

      Returns boolean

      @@ -650,12 +651,12 @@

      isObject

    • -

      Returns true if value of RequestParameter is a map of fields

      +

      Returns true if value of RequestParameter is a map of fields

      Returns boolean

      @@ -672,12 +673,12 @@

      isString

    • -

      Returns true if value of RequestParameter is a String instance

      +

      Returns true if value of RequestParameter is a String instance

      Returns boolean

      @@ -694,12 +695,12 @@

      merge

    • -

      Merge this request parameter with another one. Note: the parameter passed by argument has the priority

      +

      Merge this request parameter with another one. Note: the parameter passed by argument has the priority

      Parameters

      @@ -722,12 +723,12 @@

      setName

    • -

      Set parameter name

      +

      Set parameter name

      Parameters

      @@ -752,12 +753,12 @@

      setValue

    • -

      Set value

      +

      Set value

      Parameters

      @@ -772,6 +773,28 @@

      Returns void

    • +
    + +

    toJson

    +
      +
    • toJson(): any
      • +
    +
      +
    • + +
      +
      +

      Converts deeply this RequestParameter in a Json representation

      +
      +
      +

      Returns any

      +
      • +
    +

    Static create

    @@ -783,7 +806,7 @@

    Static create

  • Parameters

    @@ -800,7 +823,7 @@

    Returns

    Parameters

    @@ -828,9 +851,6 @@

    Returns ContainerSerializationStyle

    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -852,6 +872,12 @@

    Returns OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -944,6 +970,9 @@

    Returns setValue +
  • + toJson +
  • create
    • @@ -960,7 +989,7 @@

    Returns HTTPOperationRequestValidationHandler -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/classes/requestparameters.html b/docs/@vertx/web-api-contract/classes/requestparameters.html index 6d9d00650..4c12ef3fa 100644 --- a/docs/@vertx/web-api-contract/classes/requestparameters.html +++ b/docs/@vertx/web-api-contract/classes/requestparameters.html @@ -90,6 +90,7 @@

    Methods

  • pathParametersNames
  • queryParameter
  • queryParametersNames
    • +
  • toJson

    • @@ -107,12 +108,12 @@

    body

  • -

    Return request body

    +

    Return request body

    Returns RequestParameter @@ -132,12 +133,12 @@

    cookieParameter

  • -

    Get cookie parameter by name

    +

    Get cookie parameter by name

    Parameters

    @@ -166,12 +167,12 @@

    cookieParametersNames

  • -

    Get list of all parameter names inside cookie

    +

    Get list of all parameter names inside cookie

    Returns string[]

    @@ -188,12 +189,12 @@

    formParameter

  • -

    Get form parameter by name

    +

    Get form parameter by name

    Parameters

    @@ -222,12 +223,12 @@

    formParametersNames

  • -

    Get list of all parameter names inside body form

    +

    Get list of all parameter names inside body form

    Returns string[]

    @@ -244,12 +245,12 @@

    headerParameter

  • -

    Get header parameter by name

    +

    Get header parameter by name

    Parameters

    @@ -278,12 +279,12 @@

    headerParametersNames

  • -

    Get list of all parameter names inside header

    +

    Get list of all parameter names inside header

    Returns string[]

    @@ -300,12 +301,12 @@

    pathParameter

  • -

    Get path parameter by name

    +

    Get path parameter by name

    Parameters

    @@ -334,12 +335,12 @@

    pathParametersNames

  • -

    Get list of all parameter names inside path

    +

    Get list of all parameter names inside path

    Returns string[]

    @@ -356,12 +357,12 @@

    queryParameter

  • -

    Get query parameter by name

    +

    Get query parameter by name

    Parameters

    @@ -390,18 +391,46 @@

    queryParametersNames

  • -

    Get list of all parameter names inside query

    +

    Get list of all parameter names inside query

    Returns string[]

    • +
    + +

    toJson

    +
      +
    • toJson(): object
      • +
    +
      +
    • + +
      +
      +

      This method converts RequestParameters in an unique JsonObject with 6 fields: cookie, path, query, header, form, body

      +
      +

      cookie, path, query, header, form are JsonObject where keys are param names and values are param values, while body depends on body's shape and may not exist

      +
      +

      Returns object

      +
        +
      • +
        [key: string]: any
        +
        • +
      +
      • +
    +
    @@ -417,9 +446,6 @@

    Returns string ContainerSerializationStyle -
  • - ErrorType -
  • ParameterLocation
    • @@ -441,6 +467,12 @@

    Returns string OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -488,6 +520,9 @@

    Returns string queryParametersNames +
  • + toJson +
    • @@ -498,7 +533,7 @@

    Returns string HTTPOperationRequestValidationHandler -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/classes/routerfactoryoptions.html b/docs/@vertx/web-api-contract/classes/routerfactoryoptions.html index 02df253d0..aa1ba6447 100644 --- a/docs/@vertx/web-api-contract/classes/routerfactoryoptions.html +++ b/docs/@vertx/web-api-contract/classes/routerfactoryoptions.html @@ -77,131 +77,331 @@

    Index

    -

    Properties

    +

    Constructors

    +
    +
    +

    Methods

    +

    • -

    Properties

    -
    - -

    bodyHandler

    -
    bodyHandler: BodyHandler
    - -
    -
    -

    Supply your own BodyHandler if you would like to control body limit, uploads directory and deletion of uploaded files

    -
    -
    -
    param
    -
    -
    returns
    -

    self

    -
    -
    -
    +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    mountNotImplementedHandler

    -
    mountNotImplementedHandler: boolean
    - -
    -
    -

    Automatic mount handlers that return HTTP 501 status code for operations where you didn't specify an handler.

    -
    -
    -
    param
    -
    -
    returns
    -

    this object

    -
    -
    -
    +
    +
    +

    Methods

    +
    + +

    getOperationModelKey

    +
      +
    • getOperationModelKey(): string
      • +
    +
      +
    • + +
      +
      +

      When set, an additional handler will be created to expose the operation model in the routing + context under the given key. When the key is null, the handler is not added.

      +
      +
      +

      Returns string

      +
      • +
    -
    - -

    mountResponseContentTypeHandler

    -
    mountResponseContentTypeHandler: boolean
    - -
    -
    -

    If true, when required, the factory will mount a {@link io.vertx.ext.web.handler.ResponseContentTypeHandler}

    -
    -
    -
    param
    -
    -
    returns
    -
    -
    -
    +
    + +

    isMountNotImplementedHandler

    +
      +
    • isMountNotImplementedHandler(): boolean
      • +
    +
      +
    • + +
      +
      +

      Automatic mount handlers that return HTTP 501 status code for operations where you didn't specify an handler. + You can change the "not implemented handler" with {@link RouterFactory#setNotImplementedFailureHandler(Handler)}

      +
      +
      +

      Returns boolean

      +

      this object

      +
      • +
    -
    - -

    mountValidationFailureHandler

    -
    mountValidationFailureHandler: boolean
    - -
    -
    -

    Enable or disable validation failure handler. If you enable it during router creation a failure handler - that manages ValidationException will be mounted. You can change the validation failure handler with with function {@link RouterFactoryOptions#setValidationFailureHandler(Handler)}. If failure is different from ValidationException, next failure - handler will be called.

    -
    -
    -
    param
    -
    -
    returns
    -

    this object

    -
    -
    -
    +
    + +

    isMountResponseContentTypeHandler

    +
      +
    • isMountResponseContentTypeHandler(): boolean
      • +
    +
      +
    • + +
      +
      +

      If true, when required, the factory will mount a {@link io.vertx.ext.web.handler.ResponseContentTypeHandler}

      +
      +
      +

      Returns boolean

      +
      • +
    -
    - -

    requireSecurityHandlers

    -
    requireSecurityHandlers: boolean
    - -
    -
    -

    If true, when you call {@link RouterFactory#getRouter()} the factory will mount for every path - the required security handlers and, if a security handler is not defined, it throws an {@link RouterFactoryException}

    -
    -
    -
    param
    -
    -
    returns
    -

    this object

    -
    -
    -
    +
    + +

    isMountValidationFailureHandler

    +
      +
    • isMountValidationFailureHandler(): boolean
      • +
    +
      +
    • + +
      +
      +

      Enable or disable validation failure handler. If you enable it during router creation a failure handler + that manages ValidationException will be mounted. You can change the validation failure handler with with function {@link RouterFactory#setValidationFailureHandler(Handler)}. If failure is different from ValidationException, next failure + handler will be called.

      +
      +
      +

      Returns boolean

      +

      this object

      +
      • +
    +
    +
    + +

    isRequireSecurityHandlers

    +
      +
    • isRequireSecurityHandlers(): boolean
      • +
    +
      +
    • + +
      +
      +

      If true, when you call {@link RouterFactory#getRouter()} the factory will mount for every path + the required security handlers and, if a security handler is not defined, it throws an {@link RouterFactoryException}

      +
      +
      +

      Returns boolean

      +

      this object

      +
      • +
    +
    +
    + +

    setMountNotImplementedHandler

    + +
      +
    • + +
      +
      +

      Automatic mount handlers that return HTTP 501 status code for operations where you didn't specify an handler. + You can change the "not implemented handler" with {@link RouterFactory#setNotImplementedFailureHandler(Handler)}

      +
      +
      +

      Parameters

      +
        +
      • +
        mountNotImplementedHandler: boolean
        +
        • +
      +

      Returns RouterFactoryOptions

      +

      this object

      +
      • +
    +
    +
    + +

    setMountResponseContentTypeHandler

    +
      +
    • setMountResponseContentTypeHandler(mountResponseContentTypeHandler: boolean): RouterFactoryOptions
      • +
    +
      +
    • + +
      +
      +

      If true, when required, the factory will mount a {@link io.vertx.ext.web.handler.ResponseContentTypeHandler}

      +
      +
      +

      Parameters

      +
        +
      • +
        mountResponseContentTypeHandler: boolean
        +
        • +
      +

      Returns RouterFactoryOptions

      +
      • +
    +
    +
    + +

    setMountValidationFailureHandler

    +
      +
    • setMountValidationFailureHandler(mountValidationFailureHandler: boolean): RouterFactoryOptions
      • +
    +
      +
    • + +
      +
      +

      Enable or disable validation failure handler. If you enable it during router creation a failure handler + that manages ValidationException will be mounted. You can change the validation failure handler with with function {@link RouterFactory#setValidationFailureHandler(Handler)}. If failure is different from ValidationException, next failure + handler will be called.

      +
      +
      +

      Parameters

      +
        +
      • +
        mountValidationFailureHandler: boolean
        +
        • +
      +

      Returns RouterFactoryOptions

      +

      this object

      +
      • +
    +
    +
    + +

    setOperationModelKey

    + +
      +
    • + +
      +
      +

      When set, an additional handler will be created to expose the operation model in the routing + context under the given key. When the key is null, the handler is not added.

      +
      +
      +

      Parameters

      +
        +
      • +
        operationModelKey: string
        +
        • +
      +

      Returns RouterFactoryOptions

      +
      • +
    +
    +
    + +

    setRequireSecurityHandlers

    + +
      +
    • + +
      +
      +

      If true, when you call {@link RouterFactory#getRouter()} the factory will mount for every path + the required security handlers and, if a security handler is not defined, it throws an {@link RouterFactoryException}

      +
      +
      +

      Parameters

      +
        +
      • +
        requireSecurityHandlers: boolean
        +
        • +
      +

      Returns RouterFactoryOptions

      +

      this object

      +
      • +
    @@ -218,9 +418,6 @@

    requireSecurityHandlers

  • ContainerSerializationStyle
    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -242,6 +439,12 @@

    requireSecurityHandlers

  • OpenAPI3RouterFactory
    • +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -259,20 +462,38 @@

    requireSecurityHandlers

  • RouterFactoryOptions
    • @@ -281,7 +502,7 @@

    requireSecurityHandlers

  • HTTPOperationRequestValidationHandler
    • -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/enums/containerserializationstyle.html b/docs/@vertx/web-api-contract/enums/containerserializationstyle.html index f48800f0b..1a4473f40 100644 --- a/docs/@vertx/web-api-contract/enums/containerserializationstyle.html +++ b/docs/@vertx/web-api-contract/enums/containerserializationstyle.html @@ -90,7 +90,7 @@

    csv

    csv:
    • @@ -100,7 +100,7 @@

    dsv

    dsv:
    @@ -110,7 +110,7 @@

    matrix_exploded_array

    matrix_exploded_array:
    @@ -120,7 +120,7 @@

    psv

    psv:
    @@ -130,7 +130,7 @@

    simple_exploded_object

    simple_exploded_object:
    @@ -140,7 +140,7 @@

    ssv

    ssv:
    @@ -183,9 +183,6 @@

    ssv

    @@ -103,7 +103,7 @@

    BODY_FORM

    BODY_FORM:
    @@ -113,7 +113,7 @@

    BODY_JSON

    BODY_JSON:
    @@ -123,7 +123,7 @@

    BODY_XML

    BODY_XML:
    @@ -133,7 +133,7 @@

    COOKIE

    COOKIE:
    @@ -143,7 +143,7 @@

    FILE

    FILE:
    @@ -153,7 +153,7 @@

    HEADER

    HEADER:
    @@ -163,7 +163,7 @@

    PATH

    PATH:
    @@ -173,7 +173,7 @@

    QUERY

    QUERY:
    @@ -192,9 +192,6 @@

    QUERY

  • ContainerSerializationStyle
    • -
  • - ErrorType -
    • @@ -98,7 +99,7 @@

    BASE64

    BASE64:
    @@ -108,7 +109,7 @@

    BOOL

    BOOL:
    @@ -118,7 +119,7 @@

    DATE

    DATE:
    @@ -128,7 +129,7 @@

    DATETIME

    DATETIME:
    @@ -138,7 +139,7 @@

    DOUBLE

    DOUBLE:
    @@ -148,7 +149,7 @@

    EMAIL

    EMAIL:
    @@ -158,7 +159,7 @@

    FLOAT

    FLOAT:
    @@ -168,7 +169,7 @@

    GENERIC_STRING

    GENERIC_STRING:
    @@ -178,7 +179,7 @@

    HOSTNAME

    HOSTNAME:
    @@ -188,7 +189,7 @@

    INT

    INT:
    @@ -198,7 +199,7 @@

    IPV4

    IPV4:
    @@ -208,7 +209,7 @@

    IPV6

    IPV6:
    @@ -218,7 +219,7 @@

    TIME

    TIME:
    @@ -228,7 +229,17 @@

    URI

    URI:
    +
    +
    + +

    UUID

    +
    UUID:
    +
    @@ -247,9 +258,6 @@

    URI

  • ContainerSerializationStyle
    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -300,6 +308,9 @@

    URI

  • URI
    • +
  • + UUID +
    • @@ -319,6 +330,12 @@

    URI

  • OpenAPI3RouterFactory
    • +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -337,7 +354,7 @@

    URI

  • HTTPOperationRequestValidationHandler
    • -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/globals.html b/docs/@vertx/web-api-contract/globals.html index 725be0a7a..f0d7ec6aa 100644 --- a/docs/@vertx/web-api-contract/globals.html +++ b/docs/@vertx/web-api-contract/globals.html @@ -69,7 +69,6 @@

    Index

    Enumerations

    @@ -82,6 +81,8 @@

    Classes

  • HTTPRequestValidationHandler
  • OpenAPI3RequestValidationHandler
  • OpenAPI3RouterFactory
    • +
  • OperationRequest
    • +
  • OperationResponse
  • ParameterTypeValidator
  • ParameterValidationRule
  • RequestParameter
    • @@ -93,7 +94,7 @@

    Classes

    Interfaces

    @@ -114,9 +115,6 @@

    Interfaces

  • ContainerSerializationStyle
    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -138,6 +136,12 @@

    Interfaces

  • OpenAPI3RouterFactory
    • +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -156,7 +160,7 @@

    Interfaces

  • HTTPOperationRequestValidationHandler
    • -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/index.html b/docs/@vertx/web-api-contract/index.html index 64d23f3b7..9d0e5bfb2 100644 --- a/docs/@vertx/web-api-contract/index.html +++ b/docs/@vertx/web-api-contract/index.html @@ -110,9 +110,6 @@
  • ContainerSerializationStyle
    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -134,6 +131,12 @@
  • OpenAPI3RouterFactory
    • +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -152,7 +155,7 @@
  • HTTPOperationRequestValidationHandler
    • -
  • +
  • RouterFactory
  • diff --git a/docs/@vertx/web-api-contract/interfaces/httpoperationrequestvalidationhandler.html b/docs/@vertx/web-api-contract/interfaces/httpoperationrequestvalidationhandler.html index a31611a68..998e84cc6 100644 --- a/docs/@vertx/web-api-contract/interfaces/httpoperationrequestvalidationhandler.html +++ b/docs/@vertx/web-api-contract/interfaces/httpoperationrequestvalidationhandler.html @@ -68,10 +68,21 @@

    Interface HTTPOperationRequestValidationHandler

    Hierarchy

    • - HTTPOperationRequestValidationHandler + any +
        +
      • + HTTPOperationRequestValidationHandler +
        • +
    • +
    +

    Implemented by

    + +

    Index

    @@ -98,7 +109,7 @@

    handle

  • Parameters

    @@ -121,12 +132,12 @@

    parseOperationSpec

  • -

    Function that parse the operation specification and generate validation rules

    +

    Function that parse the operation specification and generate validation rules

    Returns void

    @@ -148,9 +159,6 @@

    Returns void ContainerSerializationStyle

    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -172,6 +180,12 @@

    Returns void OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -202,7 +216,7 @@

    Returns void
      -
    • +
    • RouterFactory
    • diff --git a/docs/@vertx/web-api-contract/interfaces/routerfactory.html b/docs/@vertx/web-api-contract/interfaces/routerfactory.html index 2d8843428..5e8f97f83 100644 --- a/docs/@vertx/web-api-contract/interfaces/routerfactory.html +++ b/docs/@vertx/web-api-contract/interfaces/routerfactory.html @@ -57,13 +57,21 @@ RouterFactory
    -

    Interface RouterFactory

    +

    Interface RouterFactory<Specification>

    +
    +

    Type parameters

    +
      +
    • +

      Specification

      +
      • +
    +

    Hierarchy

      @@ -72,6 +80,12 @@

      Hierarchy

    +
    +

    Implemented by

    + +

    Index

    @@ -79,13 +93,14 @@

    Index

    Methods

    @@ -96,263 +111,321 @@

    Methods

    Methods

    - -

    addFailureHandler

    + +

    addGlobalHandler

      -
    • addFailureHandler(method: HttpMethod, path: string, failureHandler: function): RouterFactory
      • +
    • addGlobalHandler(globalHandler: function): RouterFactory<any>
    • -

      Add a failure handler to a path with a method. If combination path/method is not available in - specification, it will throw a {@link RouterFactoryException}. Deprecated in favour of - operation id

      +

      Add global handler to be applied prior to {@link io.vertx.ext.web.Router} being generated.
      + Please note that you should not add a body handler inside that list. If you want to modify the body handler, please use {@link RouterFactory#setBodyHandler(BodyHandler)}

      Parameters

      • -
        method: HttpMethod
        -
        • -
      • -
        path: string
        -
        • -
      • -
        failureHandler: function
        +
        globalHandler: function
          • -
          • (result: RoutingContext): void
            • +
          • (res: RoutingContext): void | Handler<RoutingContext>

          • Parameters

            • -
              result: RoutingContext
              +
              res: RoutingContext
            -

            Returns void

            +

            Returns void + | + Handler<RoutingContext> +

      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

      +

      this object

    - -

    addHandler

    + +

    addSecurityHandler

      -
    • addHandler(method: HttpMethod, path: string, handler: function): RouterFactory
      • +
    • addSecurityHandler(securitySchemaName: string, handler: function): RouterFactory<any>
    • -

      Add an handler to a path with a method. If combination path/method is not available in - specification, it will throw a {@link RouterFactoryException}. Deprecated in favour of - operation id

      +

      Mount to paths that have to follow a security schema a security handler

      Parameters

      • -
        method: HttpMethod
        -
        • -
      • -
        path: string
        +
        securitySchemaName: string
      • handler: function
          • -
          • (result: RoutingContext): void
            • +
          • (res: RoutingContext): void | Handler<RoutingContext>

          • Parameters

            • -
              result: RoutingContext
              +
              res: RoutingContext
            -

            Returns void

            +

            Returns void + | + Handler<RoutingContext> +

      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

    - -

    addSecurityHandler

    + +

    getOptions

    • -

      Mount to paths that have to follow a security schema a security handler

      +

      Get options of router factory. For more info RouterFactoryOptions

      -

      Parameters

      -
        -
      • -
        securitySchemaName: string
        -
        • -
      • -
        handler: function
        -
          -
        • -
            -
          • (result: RoutingContext): void
            • -
          -
            -
          • -

            Parameters

            -
              -
            • -
              result: RoutingContext
              -
              • -
            -

            Returns void

            -
            • -
          -
          • -
        -
        • -
      -

      Returns RouterFactory

      +

      Returns RouterFactoryOptions

    - -

    enableValidationFailureHandler

    + +

    getRouter

      -
    • enableValidationFailureHandler(enable: boolean): RouterFactory
      • +
    • getRouter(): Router
    • -

      Deprecated. Instantiate RouterFactoryOptions - and load it using {@link RouterFactory#setOptions(RouterFactoryOptions)}

      +

      Construct a new router based on spec. It will fail if you are trying to mount a spec with security schemes + without assigned handlers
      + Note: Router is constructed in this function, so it will be respected the path definition ordering.

      -

      Parameters

      +

      Returns Router

      +
      • +
    +
    +
    + +

    getValidationFailureHandler

    +
      +
    • getValidationFailureHandler(): function
      • +
    +
      +
    • + +

      Returns function

        -
      • -
        enable: boolean
        +
      • +
          +
        • (res: RoutingContext): void | Handler<RoutingContext>
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            res: RoutingContext
            +
            • +
          +

          Returns void + | + Handler<RoutingContext> +

          +
          • +
      -

      Returns RouterFactory

    - -

    getOptions

    + +

    setBodyHandler

    • -

      Get options of router factory. For more info RouterFactoryOptions

      +

      Supply your own BodyHandler if you would like to control body limit, uploads directory and deletion of uploaded files

      -

      Returns RouterFactoryOptions

      +

      Parameters

      +
        +
      • +
        bodyHandler: BodyHandler
        +
        • +
      +

      Returns RouterFactory<any>

      +

      self

    - -

    getRouter

    + +

    setExtraOperationContextPayloadMapper

      -
    • getRouter(): Router
      • +
    • setExtraOperationContextPayloadMapper(extraOperationContextPayloadMapper: function): RouterFactory<any>
    • -

      Construct a new router based on spec. It will fail if you are trying to mount a spec with security schemes - without assigned handlers
      - Note: Router is constructed in this function, so it will be respected the path definition ordering.

      +

      When set, this function is called while creating the payload of {@link io.vertx.ext.web.api.OperationRequest}

      -

      Returns Router

      +

      Parameters

      +
        +
      • +
        extraOperationContextPayloadMapper: function
        +
          +
        • +
            +
          • (arg: RoutingContext): object
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              arg: RoutingContext
              +
              • +
            +

            Returns object

            +
              +
            • +
              [key: string]: any
              +
              • +
            +
            • +
          +
          • +
        +
        • +
      +

      Returns RouterFactory<any>

    - -

    mountOperationsWithoutHandlers

    + +

    setNotImplementedFailureHandler

      -
    • mountOperationsWithoutHandlers(enable: boolean): RouterFactory
      • +
    • setNotImplementedFailureHandler(notImplementedFailureHandler: function): RouterFactory<any>
    • -

      Deprecated. Instantiate RouterFactoryOptions - and load it using {@link RouterFactory#setOptions(RouterFactoryOptions)}

      +

      Set not implemented failure handler. It's called when you don't define an handler for a + specific operation. You can enable/disable this feature from + {@link RouterFactoryOptions#setMountNotImplementedHandler(boolean)}

      Parameters

      • -
        enable: boolean
        +
        notImplementedFailureHandler: function
        +
          +
        • +
            +
          • (res: RoutingContext): void | Handler<RoutingContext>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: RoutingContext
              +
              • +
            +

            Returns void + | + Handler<RoutingContext> +

            +
            • +
          +
          • +
      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

      +

      this object

    @@ -360,18 +433,18 @@

    Returns

    setOptions

    • -

      Override options

      +

      Set options of router factory. For more info RouterFactoryOptions

      Parameters

      @@ -380,7 +453,7 @@

      Parameters

      options: RouterFactoryOptions
    -

    Returns RouterFactory

    +

    Returns RouterFactory<any>

    @@ -388,46 +461,50 @@

    Returns

    setValidationFailureHandler

      -
    • setValidationFailureHandler(handler: function): RouterFactory
      • +
    • setValidationFailureHandler(validationFailureHandler: function): RouterFactory<any>
    • -

      Deprecated. Instantiate RouterFactoryOptions - and load it using {@link RouterFactory#setOptions(RouterFactoryOptions)}

      +

      Set default validation failure handler. You can enable/disable this feature from + {@link RouterFactoryOptions#setMountValidationFailureHandler(boolean)}

      Parameters

      • -
        handler: function
        +
        validationFailureHandler: function
          • -
          • (result: RoutingContext): void
            • +
          • (res: RoutingContext): void | Handler<RoutingContext>

          • Parameters

            • -
              result: RoutingContext
              +
              res: RoutingContext
            -

            Returns void

            +

            Returns void + | + Handler<RoutingContext> +

      -

      Returns RouterFactory

      +

      Returns RouterFactory<any>

      +

      this object

    @@ -446,9 +523,6 @@

    Returns ContainerSerializationStyle -
  • - ErrorType -
  • ParameterLocation
    • @@ -470,6 +544,12 @@

    Returns OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -490,29 +570,32 @@

    Returns -
  • +
  • RouterFactory

    • +
    +

    Implemented by

    + +

    Index

    @@ -97,7 +108,7 @@

    handle

  • Parameters

    @@ -125,9 +136,6 @@

    Returns void ContainerSerializationStyle

    • -
  • - ErrorType -
  • ParameterLocation
    • @@ -149,6 +157,12 @@

    Returns void OpenAPI3RouterFactory +
  • + OperationRequest +
    • +
  • + OperationResponse +
  • ParameterTypeValidator
    • @@ -167,7 +181,7 @@

    Returns void HTTPOperationRequestValidationHandler -
  • +
  • RouterFactory
    • diff --git a/docs/@vertx/web-client/assets/js/search.js b/docs/@vertx/web-client/assets/js/search.js index 0b8076917..95488f1a6 100644 --- a/docs/@vertx/web-client/assets/js/search.js +++ b/docs/@vertx/web-client/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"128":"Class","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"WebClientOptions","url":"classes/webclientoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":1024,"name":"alpnVersions","url":"classes/webclientoptions.html#alpnversions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":2,"kind":1024,"name":"connectTimeout","url":"classes/webclientoptions.html#connecttimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":3,"kind":1024,"name":"crlPaths","url":"classes/webclientoptions.html#crlpaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":4,"kind":1024,"name":"crlValues","url":"classes/webclientoptions.html#crlvalues","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":5,"kind":1024,"name":"decoderInitialBufferSize","url":"classes/webclientoptions.html#decoderinitialbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":6,"kind":1024,"name":"defaultHost","url":"classes/webclientoptions.html#defaulthost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":7,"kind":1024,"name":"defaultPort","url":"classes/webclientoptions.html#defaultport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":8,"kind":1024,"name":"enabledCipherSuites","url":"classes/webclientoptions.html#enabledciphersuites","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":9,"kind":1024,"name":"enabledSecureTransportProtocols","url":"classes/webclientoptions.html#enabledsecuretransportprotocols","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":10,"kind":1024,"name":"followRedirects","url":"classes/webclientoptions.html#followredirects","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":11,"kind":1024,"name":"forceSni","url":"classes/webclientoptions.html#forcesni","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":12,"kind":1024,"name":"http2ClearTextUpgrade","url":"classes/webclientoptions.html#http2cleartextupgrade","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":13,"kind":1024,"name":"http2ConnectionWindowSize","url":"classes/webclientoptions.html#http2connectionwindowsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":14,"kind":1024,"name":"http2KeepAliveTimeout","url":"classes/webclientoptions.html#http2keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":15,"kind":1024,"name":"http2MaxPoolSize","url":"classes/webclientoptions.html#http2maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":16,"kind":1024,"name":"http2MultiplexingLimit","url":"classes/webclientoptions.html#http2multiplexinglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":17,"kind":1024,"name":"idleTimeout","url":"classes/webclientoptions.html#idletimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":18,"kind":1024,"name":"initialSettings","url":"classes/webclientoptions.html#initialsettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":19,"kind":1024,"name":"jdkSslEngineOptions","url":"classes/webclientoptions.html#jdksslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":20,"kind":1024,"name":"keepAlive","url":"classes/webclientoptions.html#keepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":21,"kind":1024,"name":"keepAliveTimeout","url":"classes/webclientoptions.html#keepalivetimeout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":22,"kind":1024,"name":"keyStoreOptions","url":"classes/webclientoptions.html#keystoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":23,"kind":1024,"name":"localAddress","url":"classes/webclientoptions.html#localaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":24,"kind":1024,"name":"logActivity","url":"classes/webclientoptions.html#logactivity","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":25,"kind":1024,"name":"maxChunkSize","url":"classes/webclientoptions.html#maxchunksize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":26,"kind":1024,"name":"maxHeaderSize","url":"classes/webclientoptions.html#maxheadersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":27,"kind":1024,"name":"maxInitialLineLength","url":"classes/webclientoptions.html#maxinitiallinelength","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":28,"kind":1024,"name":"maxPoolSize","url":"classes/webclientoptions.html#maxpoolsize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":29,"kind":1024,"name":"maxRedirects","url":"classes/webclientoptions.html#maxredirects","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":30,"kind":1024,"name":"maxWaitQueueSize","url":"classes/webclientoptions.html#maxwaitqueuesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":31,"kind":1024,"name":"maxWebsocketFrameSize","url":"classes/webclientoptions.html#maxwebsocketframesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":32,"kind":1024,"name":"maxWebsocketMessageSize","url":"classes/webclientoptions.html#maxwebsocketmessagesize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":33,"kind":1024,"name":"metricsName","url":"classes/webclientoptions.html#metricsname","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":34,"kind":1024,"name":"openSslEngineOptions","url":"classes/webclientoptions.html#opensslengineoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":35,"kind":1024,"name":"pemKeyCertOptions","url":"classes/webclientoptions.html#pemkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":36,"kind":1024,"name":"pemTrustOptions","url":"classes/webclientoptions.html#pemtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":37,"kind":1024,"name":"pfxKeyCertOptions","url":"classes/webclientoptions.html#pfxkeycertoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":38,"kind":1024,"name":"pfxTrustOptions","url":"classes/webclientoptions.html#pfxtrustoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":39,"kind":1024,"name":"pipelining","url":"classes/webclientoptions.html#pipelining","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":40,"kind":1024,"name":"pipeliningLimit","url":"classes/webclientoptions.html#pipelininglimit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":41,"kind":1024,"name":"poolCleanerPeriod","url":"classes/webclientoptions.html#poolcleanerperiod","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":42,"kind":1024,"name":"protocolVersion","url":"classes/webclientoptions.html#protocolversion","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":43,"kind":1024,"name":"proxyOptions","url":"classes/webclientoptions.html#proxyoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":44,"kind":1024,"name":"receiveBufferSize","url":"classes/webclientoptions.html#receivebuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":45,"kind":1024,"name":"reuseAddress","url":"classes/webclientoptions.html#reuseaddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":46,"kind":1024,"name":"reusePort","url":"classes/webclientoptions.html#reuseport","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":47,"kind":1024,"name":"sendBufferSize","url":"classes/webclientoptions.html#sendbuffersize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":48,"kind":1024,"name":"sendUnmaskedFrames","url":"classes/webclientoptions.html#sendunmaskedframes","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":49,"kind":1024,"name":"soLinger","url":"classes/webclientoptions.html#solinger","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":50,"kind":1024,"name":"ssl","url":"classes/webclientoptions.html#ssl","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":51,"kind":1024,"name":"tcpCork","url":"classes/webclientoptions.html#tcpcork","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":52,"kind":1024,"name":"tcpFastOpen","url":"classes/webclientoptions.html#tcpfastopen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":53,"kind":1024,"name":"tcpKeepAlive","url":"classes/webclientoptions.html#tcpkeepalive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":54,"kind":1024,"name":"tcpNoDelay","url":"classes/webclientoptions.html#tcpnodelay","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":55,"kind":1024,"name":"tcpQuickAck","url":"classes/webclientoptions.html#tcpquickack","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":56,"kind":1024,"name":"trafficClass","url":"classes/webclientoptions.html#trafficclass","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":57,"kind":1024,"name":"trustAll","url":"classes/webclientoptions.html#trustall","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":58,"kind":1024,"name":"trustStoreOptions","url":"classes/webclientoptions.html#truststoreoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":59,"kind":1024,"name":"tryUseCompression","url":"classes/webclientoptions.html#tryusecompression","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":60,"kind":1024,"name":"useAlpn","url":"classes/webclientoptions.html#usealpn","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":61,"kind":1024,"name":"usePooledBuffers","url":"classes/webclientoptions.html#usepooledbuffers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":62,"kind":1024,"name":"userAgent","url":"classes/webclientoptions.html#useragent","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":63,"kind":1024,"name":"userAgentEnabled","url":"classes/webclientoptions.html#useragentenabled","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":64,"kind":1024,"name":"verifyHost","url":"classes/webclientoptions.html#verifyhost","classes":"tsd-kind-property tsd-parent-kind-class","parent":"WebClientOptions"},{"id":65,"kind":128,"name":"HttpRequest","url":"classes/httprequest.html","classes":"tsd-kind-class"},{"id":66,"kind":2048,"name":"method","url":"classes/httprequest.html#method","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":67,"kind":2048,"name":"port","url":"classes/httprequest.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":68,"kind":2048,"name":"as","url":"classes/httprequest.html#as","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":69,"kind":2048,"name":"host","url":"classes/httprequest.html#host","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":70,"kind":2048,"name":"virtualHost","url":"classes/httprequest.html#virtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":71,"kind":2048,"name":"uri","url":"classes/httprequest.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":72,"kind":2048,"name":"putHeader","url":"classes/httprequest.html#putheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":73,"kind":2048,"name":"headers","url":"classes/httprequest.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":74,"kind":2048,"name":"ssl","url":"classes/httprequest.html#ssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":75,"kind":2048,"name":"timeout","url":"classes/httprequest.html#timeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":76,"kind":2048,"name":"addQueryParam","url":"classes/httprequest.html#addqueryparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":77,"kind":2048,"name":"setQueryParam","url":"classes/httprequest.html#setqueryparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":78,"kind":2048,"name":"followRedirects","url":"classes/httprequest.html#followredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":79,"kind":2048,"name":"queryParams","url":"classes/httprequest.html#queryparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":80,"kind":2048,"name":"copy","url":"classes/httprequest.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":81,"kind":2048,"name":"sendStream","url":"classes/httprequest.html#sendstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":82,"kind":2048,"name":"sendBuffer","url":"classes/httprequest.html#sendbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":83,"kind":2048,"name":"sendJsonObject","url":"classes/httprequest.html#sendjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":84,"kind":2048,"name":"sendJson","url":"classes/httprequest.html#sendjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":85,"kind":2048,"name":"sendForm","url":"classes/httprequest.html#sendform","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":86,"kind":2048,"name":"send","url":"classes/httprequest.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":87,"kind":128,"name":"HttpResponse","url":"classes/httpresponse.html","classes":"tsd-kind-class"},{"id":88,"kind":2048,"name":"version","url":"classes/httpresponse.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":89,"kind":2048,"name":"statusCode","url":"classes/httpresponse.html#statuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":90,"kind":2048,"name":"statusMessage","url":"classes/httpresponse.html#statusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":91,"kind":2048,"name":"headers","url":"classes/httpresponse.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":92,"kind":2048,"name":"getHeader","url":"classes/httpresponse.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":93,"kind":2048,"name":"trailers","url":"classes/httpresponse.html#trailers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":94,"kind":2048,"name":"getTrailer","url":"classes/httpresponse.html#gettrailer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":95,"kind":2048,"name":"cookies","url":"classes/httpresponse.html#cookies","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":96,"kind":2048,"name":"body","url":"classes/httpresponse.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":97,"kind":2048,"name":"bodyAsBuffer","url":"classes/httpresponse.html#bodyasbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":98,"kind":2048,"name":"bodyAsString","url":"classes/httpresponse.html#bodyasstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":99,"kind":2048,"name":"bodyAsJsonObject","url":"classes/httpresponse.html#bodyasjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":100,"kind":2048,"name":"bodyAsJsonArray","url":"classes/httpresponse.html#bodyasjsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":101,"kind":2048,"name":"bodyAsJson","url":"classes/httpresponse.html#bodyasjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":102,"kind":128,"name":"WebClient","url":"classes/webclient.html","classes":"tsd-kind-class"},{"id":103,"kind":2048,"name":"create","url":"classes/webclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebClient"},{"id":104,"kind":2048,"name":"wrap","url":"classes/webclient.html#wrap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebClient"},{"id":105,"kind":2048,"name":"request","url":"classes/webclient.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":106,"kind":2048,"name":"requestAbs","url":"classes/webclient.html#requestabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":107,"kind":2048,"name":"get","url":"classes/webclient.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":108,"kind":2048,"name":"getAbs","url":"classes/webclient.html#getabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":109,"kind":2048,"name":"post","url":"classes/webclient.html#post","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":110,"kind":2048,"name":"postAbs","url":"classes/webclient.html#postabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":111,"kind":2048,"name":"put","url":"classes/webclient.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":112,"kind":2048,"name":"putAbs","url":"classes/webclient.html#putabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":113,"kind":2048,"name":"delete","url":"classes/webclient.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":114,"kind":2048,"name":"deleteAbs","url":"classes/webclient.html#deleteabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":115,"kind":2048,"name":"patch","url":"classes/webclient.html#patch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":116,"kind":2048,"name":"patchAbs","url":"classes/webclient.html#patchabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":117,"kind":2048,"name":"head","url":"classes/webclient.html#head","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":118,"kind":2048,"name":"headAbs","url":"classes/webclient.html#headabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":119,"kind":2048,"name":"close","url":"classes/webclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"128":"Class","512":"Constructor","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"WebClientOptions","url":"classes/webclientoptions.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/webclientoptions.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"WebClientOptions"},{"id":2,"kind":2048,"name":"getAlpnVersions","url":"classes/webclientoptions.html#getalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":3,"kind":2048,"name":"setAlpnVersions","url":"classes/webclientoptions.html#setalpnversions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":4,"kind":2048,"name":"getConnectTimeout","url":"classes/webclientoptions.html#getconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":5,"kind":2048,"name":"setConnectTimeout","url":"classes/webclientoptions.html#setconnecttimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":6,"kind":2048,"name":"getCrlPaths","url":"classes/webclientoptions.html#getcrlpaths","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":7,"kind":2048,"name":"addCrlPath","url":"classes/webclientoptions.html#addcrlpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":8,"kind":2048,"name":"getCrlValues","url":"classes/webclientoptions.html#getcrlvalues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":9,"kind":2048,"name":"addCrlValue","url":"classes/webclientoptions.html#addcrlvalue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":10,"kind":2048,"name":"getDecoderInitialBufferSize","url":"classes/webclientoptions.html#getdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":11,"kind":2048,"name":"setDecoderInitialBufferSize","url":"classes/webclientoptions.html#setdecoderinitialbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":12,"kind":2048,"name":"getDefaultHost","url":"classes/webclientoptions.html#getdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":13,"kind":2048,"name":"setDefaultHost","url":"classes/webclientoptions.html#setdefaulthost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":14,"kind":2048,"name":"getDefaultPort","url":"classes/webclientoptions.html#getdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":15,"kind":2048,"name":"setDefaultPort","url":"classes/webclientoptions.html#setdefaultport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":16,"kind":2048,"name":"getEnabledCipherSuites","url":"classes/webclientoptions.html#getenabledciphersuites","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":17,"kind":2048,"name":"addEnabledCipherSuite","url":"classes/webclientoptions.html#addenabledciphersuite","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":18,"kind":2048,"name":"getEnabledSecureTransportProtocols","url":"classes/webclientoptions.html#getenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":19,"kind":2048,"name":"setEnabledSecureTransportProtocols","url":"classes/webclientoptions.html#setenabledsecuretransportprotocols","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":20,"kind":2048,"name":"addEnabledSecureTransportProtocol","url":"classes/webclientoptions.html#addenabledsecuretransportprotocol","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":21,"kind":2048,"name":"isFollowRedirects","url":"classes/webclientoptions.html#isfollowredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":22,"kind":2048,"name":"setFollowRedirects","url":"classes/webclientoptions.html#setfollowredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":23,"kind":2048,"name":"isForceSni","url":"classes/webclientoptions.html#isforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":24,"kind":2048,"name":"setForceSni","url":"classes/webclientoptions.html#setforcesni","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":25,"kind":2048,"name":"isHttp2ClearTextUpgrade","url":"classes/webclientoptions.html#ishttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":26,"kind":2048,"name":"setHttp2ClearTextUpgrade","url":"classes/webclientoptions.html#sethttp2cleartextupgrade","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":27,"kind":2048,"name":"getHttp2ConnectionWindowSize","url":"classes/webclientoptions.html#gethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":28,"kind":2048,"name":"setHttp2ConnectionWindowSize","url":"classes/webclientoptions.html#sethttp2connectionwindowsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":29,"kind":2048,"name":"getHttp2KeepAliveTimeout","url":"classes/webclientoptions.html#gethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":30,"kind":2048,"name":"setHttp2KeepAliveTimeout","url":"classes/webclientoptions.html#sethttp2keepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":31,"kind":2048,"name":"getHttp2MaxPoolSize","url":"classes/webclientoptions.html#gethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":32,"kind":2048,"name":"setHttp2MaxPoolSize","url":"classes/webclientoptions.html#sethttp2maxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":33,"kind":2048,"name":"getHttp2MultiplexingLimit","url":"classes/webclientoptions.html#gethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":34,"kind":2048,"name":"setHttp2MultiplexingLimit","url":"classes/webclientoptions.html#sethttp2multiplexinglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":35,"kind":2048,"name":"getIdleTimeout","url":"classes/webclientoptions.html#getidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":36,"kind":2048,"name":"setIdleTimeout","url":"classes/webclientoptions.html#setidletimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":37,"kind":2048,"name":"getIdleTimeoutUnit","url":"classes/webclientoptions.html#getidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":38,"kind":2048,"name":"setIdleTimeoutUnit","url":"classes/webclientoptions.html#setidletimeoutunit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":39,"kind":2048,"name":"getInitialSettings","url":"classes/webclientoptions.html#getinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":40,"kind":2048,"name":"setInitialSettings","url":"classes/webclientoptions.html#setinitialsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":41,"kind":2048,"name":"getJdkSslEngineOptions","url":"classes/webclientoptions.html#getjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":42,"kind":2048,"name":"setJdkSslEngineOptions","url":"classes/webclientoptions.html#setjdksslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":43,"kind":2048,"name":"isKeepAlive","url":"classes/webclientoptions.html#iskeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":44,"kind":2048,"name":"setKeepAlive","url":"classes/webclientoptions.html#setkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":45,"kind":2048,"name":"getKeepAliveTimeout","url":"classes/webclientoptions.html#getkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":46,"kind":2048,"name":"setKeepAliveTimeout","url":"classes/webclientoptions.html#setkeepalivetimeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":47,"kind":2048,"name":"getKeyStoreOptions","url":"classes/webclientoptions.html#getkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":48,"kind":2048,"name":"setKeyStoreOptions","url":"classes/webclientoptions.html#setkeystoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":49,"kind":2048,"name":"getLocalAddress","url":"classes/webclientoptions.html#getlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":50,"kind":2048,"name":"setLocalAddress","url":"classes/webclientoptions.html#setlocaladdress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":51,"kind":2048,"name":"getLogActivity","url":"classes/webclientoptions.html#getlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":52,"kind":2048,"name":"setLogActivity","url":"classes/webclientoptions.html#setlogactivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":53,"kind":2048,"name":"getMaxChunkSize","url":"classes/webclientoptions.html#getmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":54,"kind":2048,"name":"setMaxChunkSize","url":"classes/webclientoptions.html#setmaxchunksize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":55,"kind":2048,"name":"getMaxHeaderSize","url":"classes/webclientoptions.html#getmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":56,"kind":2048,"name":"setMaxHeaderSize","url":"classes/webclientoptions.html#setmaxheadersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":57,"kind":2048,"name":"getMaxInitialLineLength","url":"classes/webclientoptions.html#getmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":58,"kind":2048,"name":"setMaxInitialLineLength","url":"classes/webclientoptions.html#setmaxinitiallinelength","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":59,"kind":2048,"name":"getMaxPoolSize","url":"classes/webclientoptions.html#getmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":60,"kind":2048,"name":"setMaxPoolSize","url":"classes/webclientoptions.html#setmaxpoolsize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":61,"kind":2048,"name":"getMaxRedirects","url":"classes/webclientoptions.html#getmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":62,"kind":2048,"name":"setMaxRedirects","url":"classes/webclientoptions.html#setmaxredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":63,"kind":2048,"name":"getMaxWaitQueueSize","url":"classes/webclientoptions.html#getmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":64,"kind":2048,"name":"setMaxWaitQueueSize","url":"classes/webclientoptions.html#setmaxwaitqueuesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":65,"kind":2048,"name":"getMaxWebsocketFrameSize","url":"classes/webclientoptions.html#getmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":66,"kind":2048,"name":"setMaxWebsocketFrameSize","url":"classes/webclientoptions.html#setmaxwebsocketframesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":67,"kind":2048,"name":"getMaxWebsocketMessageSize","url":"classes/webclientoptions.html#getmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":68,"kind":2048,"name":"setMaxWebsocketMessageSize","url":"classes/webclientoptions.html#setmaxwebsocketmessagesize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":69,"kind":2048,"name":"getMetricsName","url":"classes/webclientoptions.html#getmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":70,"kind":2048,"name":"setMetricsName","url":"classes/webclientoptions.html#setmetricsname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":71,"kind":2048,"name":"getOpenSslEngineOptions","url":"classes/webclientoptions.html#getopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":72,"kind":2048,"name":"setOpenSslEngineOptions","url":"classes/webclientoptions.html#setopensslengineoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":73,"kind":2048,"name":"getPemKeyCertOptions","url":"classes/webclientoptions.html#getpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":74,"kind":2048,"name":"setPemKeyCertOptions","url":"classes/webclientoptions.html#setpemkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":75,"kind":2048,"name":"getPemTrustOptions","url":"classes/webclientoptions.html#getpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":76,"kind":2048,"name":"setPemTrustOptions","url":"classes/webclientoptions.html#setpemtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":77,"kind":2048,"name":"getPfxKeyCertOptions","url":"classes/webclientoptions.html#getpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":78,"kind":2048,"name":"setPfxKeyCertOptions","url":"classes/webclientoptions.html#setpfxkeycertoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":79,"kind":2048,"name":"getPfxTrustOptions","url":"classes/webclientoptions.html#getpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":80,"kind":2048,"name":"setPfxTrustOptions","url":"classes/webclientoptions.html#setpfxtrustoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":81,"kind":2048,"name":"isPipelining","url":"classes/webclientoptions.html#ispipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":82,"kind":2048,"name":"setPipelining","url":"classes/webclientoptions.html#setpipelining","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":83,"kind":2048,"name":"getPipeliningLimit","url":"classes/webclientoptions.html#getpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":84,"kind":2048,"name":"setPipeliningLimit","url":"classes/webclientoptions.html#setpipelininglimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":85,"kind":2048,"name":"getPoolCleanerPeriod","url":"classes/webclientoptions.html#getpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":86,"kind":2048,"name":"setPoolCleanerPeriod","url":"classes/webclientoptions.html#setpoolcleanerperiod","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":87,"kind":2048,"name":"getProtocolVersion","url":"classes/webclientoptions.html#getprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":88,"kind":2048,"name":"setProtocolVersion","url":"classes/webclientoptions.html#setprotocolversion","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":89,"kind":2048,"name":"getProxyOptions","url":"classes/webclientoptions.html#getproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":90,"kind":2048,"name":"setProxyOptions","url":"classes/webclientoptions.html#setproxyoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":91,"kind":2048,"name":"getReceiveBufferSize","url":"classes/webclientoptions.html#getreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":92,"kind":2048,"name":"setReceiveBufferSize","url":"classes/webclientoptions.html#setreceivebuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":93,"kind":2048,"name":"isReuseAddress","url":"classes/webclientoptions.html#isreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":94,"kind":2048,"name":"setReuseAddress","url":"classes/webclientoptions.html#setreuseaddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":95,"kind":2048,"name":"isReusePort","url":"classes/webclientoptions.html#isreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":96,"kind":2048,"name":"setReusePort","url":"classes/webclientoptions.html#setreuseport","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":97,"kind":2048,"name":"getSendBufferSize","url":"classes/webclientoptions.html#getsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":98,"kind":2048,"name":"setSendBufferSize","url":"classes/webclientoptions.html#setsendbuffersize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":99,"kind":2048,"name":"isSendUnmaskedFrames","url":"classes/webclientoptions.html#issendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":100,"kind":2048,"name":"setSendUnmaskedFrames","url":"classes/webclientoptions.html#setsendunmaskedframes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":101,"kind":2048,"name":"getSoLinger","url":"classes/webclientoptions.html#getsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":102,"kind":2048,"name":"setSoLinger","url":"classes/webclientoptions.html#setsolinger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":103,"kind":2048,"name":"isSsl","url":"classes/webclientoptions.html#isssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":104,"kind":2048,"name":"setSsl","url":"classes/webclientoptions.html#setssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":105,"kind":2048,"name":"isTcpCork","url":"classes/webclientoptions.html#istcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":106,"kind":2048,"name":"setTcpCork","url":"classes/webclientoptions.html#settcpcork","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":107,"kind":2048,"name":"isTcpFastOpen","url":"classes/webclientoptions.html#istcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":108,"kind":2048,"name":"setTcpFastOpen","url":"classes/webclientoptions.html#settcpfastopen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":109,"kind":2048,"name":"isTcpKeepAlive","url":"classes/webclientoptions.html#istcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":110,"kind":2048,"name":"setTcpKeepAlive","url":"classes/webclientoptions.html#settcpkeepalive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":111,"kind":2048,"name":"isTcpNoDelay","url":"classes/webclientoptions.html#istcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":112,"kind":2048,"name":"setTcpNoDelay","url":"classes/webclientoptions.html#settcpnodelay","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":113,"kind":2048,"name":"isTcpQuickAck","url":"classes/webclientoptions.html#istcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":114,"kind":2048,"name":"setTcpQuickAck","url":"classes/webclientoptions.html#settcpquickack","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":115,"kind":2048,"name":"getTrafficClass","url":"classes/webclientoptions.html#gettrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":116,"kind":2048,"name":"setTrafficClass","url":"classes/webclientoptions.html#settrafficclass","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":117,"kind":2048,"name":"isTrustAll","url":"classes/webclientoptions.html#istrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":118,"kind":2048,"name":"setTrustAll","url":"classes/webclientoptions.html#settrustall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":119,"kind":2048,"name":"getTrustStoreOptions","url":"classes/webclientoptions.html#gettruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":120,"kind":2048,"name":"setTrustStoreOptions","url":"classes/webclientoptions.html#settruststoreoptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":121,"kind":2048,"name":"isTryUseCompression","url":"classes/webclientoptions.html#istryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":122,"kind":2048,"name":"setTryUseCompression","url":"classes/webclientoptions.html#settryusecompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":123,"kind":2048,"name":"tryUsePerFrameWebsocketCompression","url":"classes/webclientoptions.html#tryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":124,"kind":2048,"name":"setTryUsePerFrameWebsocketCompression","url":"classes/webclientoptions.html#settryuseperframewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":125,"kind":2048,"name":"tryUsePerMessageWebsocketCompression","url":"classes/webclientoptions.html#tryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":126,"kind":2048,"name":"setTryUsePerMessageWebsocketCompression","url":"classes/webclientoptions.html#settryusepermessagewebsocketcompression","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":127,"kind":2048,"name":"isUseAlpn","url":"classes/webclientoptions.html#isusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":128,"kind":2048,"name":"setUseAlpn","url":"classes/webclientoptions.html#setusealpn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":129,"kind":2048,"name":"isUsePooledBuffers","url":"classes/webclientoptions.html#isusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":130,"kind":2048,"name":"setUsePooledBuffers","url":"classes/webclientoptions.html#setusepooledbuffers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":131,"kind":2048,"name":"getUserAgent","url":"classes/webclientoptions.html#getuseragent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":132,"kind":2048,"name":"setUserAgent","url":"classes/webclientoptions.html#setuseragent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":133,"kind":2048,"name":"isUserAgentEnabled","url":"classes/webclientoptions.html#isuseragentenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":134,"kind":2048,"name":"setUserAgentEnabled","url":"classes/webclientoptions.html#setuseragentenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":135,"kind":2048,"name":"isVerifyHost","url":"classes/webclientoptions.html#isverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":136,"kind":2048,"name":"setVerifyHost","url":"classes/webclientoptions.html#setverifyhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":137,"kind":2048,"name":"getWebsocketCompressionAllowClientNoContext","url":"classes/webclientoptions.html#getwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":138,"kind":2048,"name":"setWebsocketCompressionAllowClientNoContext","url":"classes/webclientoptions.html#setwebsocketcompressionallowclientnocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":139,"kind":2048,"name":"getWebsocketCompressionLevel","url":"classes/webclientoptions.html#getwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":140,"kind":2048,"name":"setWebsocketCompressionLevel","url":"classes/webclientoptions.html#setwebsocketcompressionlevel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":141,"kind":2048,"name":"getWebsocketCompressionRequestServerNoContext","url":"classes/webclientoptions.html#getwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":142,"kind":2048,"name":"setWebsocketCompressionRequestServerNoContext","url":"classes/webclientoptions.html#setwebsocketcompressionrequestservernocontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClientOptions"},{"id":143,"kind":128,"name":"ErrorConverter","url":"classes/errorconverter.html","classes":"tsd-kind-class"},{"id":144,"kind":2048,"name":"create","url":"classes/errorconverter.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ErrorConverter"},{"id":145,"kind":2048,"name":"createFullBody","url":"classes/errorconverter.html#createfullbody","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ErrorConverter"},{"id":146,"kind":2048,"name":"apply","url":"classes/errorconverter.html#apply","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ErrorConverter"},{"id":147,"kind":2048,"name":"requiresBody","url":"classes/errorconverter.html#requiresbody","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ErrorConverter"},{"id":148,"kind":128,"name":"HttpRequest","url":"classes/httprequest.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":149,"kind":2048,"name":"method","url":"classes/httprequest.html#method","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":150,"kind":2048,"name":"port","url":"classes/httprequest.html#port","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":151,"kind":2048,"name":"as","url":"classes/httprequest.html#as","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"HttpRequest"},{"id":152,"kind":2048,"name":"host","url":"classes/httprequest.html#host","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":153,"kind":2048,"name":"virtualHost","url":"classes/httprequest.html#virtualhost","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":154,"kind":2048,"name":"uri","url":"classes/httprequest.html#uri","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":155,"kind":2048,"name":"putHeader","url":"classes/httprequest.html#putheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":156,"kind":2048,"name":"headers","url":"classes/httprequest.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":157,"kind":2048,"name":"ssl","url":"classes/httprequest.html#ssl","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":158,"kind":2048,"name":"timeout","url":"classes/httprequest.html#timeout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":159,"kind":2048,"name":"addQueryParam","url":"classes/httprequest.html#addqueryparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":160,"kind":2048,"name":"setQueryParam","url":"classes/httprequest.html#setqueryparam","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":161,"kind":2048,"name":"followRedirects","url":"classes/httprequest.html#followredirects","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":162,"kind":2048,"name":"expect","url":"classes/httprequest.html#expect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":163,"kind":2048,"name":"queryParams","url":"classes/httprequest.html#queryparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":164,"kind":2048,"name":"copy","url":"classes/httprequest.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":165,"kind":2048,"name":"sendStream","url":"classes/httprequest.html#sendstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":166,"kind":2048,"name":"sendBuffer","url":"classes/httprequest.html#sendbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":167,"kind":2048,"name":"sendJsonObject","url":"classes/httprequest.html#sendjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":168,"kind":2048,"name":"sendJson","url":"classes/httprequest.html#sendjson","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":169,"kind":2048,"name":"sendForm","url":"classes/httprequest.html#sendform","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":170,"kind":2048,"name":"sendMultipartForm","url":"classes/httprequest.html#sendmultipartform","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":171,"kind":2048,"name":"send","url":"classes/httprequest.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpRequest"},{"id":172,"kind":128,"name":"HttpResponse","url":"classes/httpresponse.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":173,"kind":2048,"name":"version","url":"classes/httpresponse.html#version","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":174,"kind":2048,"name":"statusCode","url":"classes/httpresponse.html#statuscode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":175,"kind":2048,"name":"statusMessage","url":"classes/httpresponse.html#statusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":176,"kind":2048,"name":"headers","url":"classes/httpresponse.html#headers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":177,"kind":2048,"name":"getHeader","url":"classes/httpresponse.html#getheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":178,"kind":2048,"name":"trailers","url":"classes/httpresponse.html#trailers","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":179,"kind":2048,"name":"getTrailer","url":"classes/httpresponse.html#gettrailer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":180,"kind":2048,"name":"cookies","url":"classes/httpresponse.html#cookies","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":181,"kind":2048,"name":"body","url":"classes/httpresponse.html#body","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":182,"kind":2048,"name":"bodyAsBuffer","url":"classes/httpresponse.html#bodyasbuffer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":183,"kind":2048,"name":"bodyAsString","url":"classes/httpresponse.html#bodyasstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":184,"kind":2048,"name":"bodyAsJsonObject","url":"classes/httpresponse.html#bodyasjsonobject","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":185,"kind":2048,"name":"bodyAsJsonArray","url":"classes/httpresponse.html#bodyasjsonarray","classes":"tsd-kind-method tsd-parent-kind-class","parent":"HttpResponse"},{"id":186,"kind":2048,"name":"bodyAsJson","url":"classes/httpresponse.html#bodyasjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"HttpResponse"},{"id":187,"kind":128,"name":"ResponsePredicate","url":"classes/responsepredicate.html","classes":"tsd-kind-class"},{"id":188,"kind":2048,"name":"status","url":"classes/responsepredicate.html#status","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ResponsePredicate"},{"id":189,"kind":2048,"name":"contentType","url":"classes/responsepredicate.html#contenttype","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ResponsePredicate"},{"id":190,"kind":2048,"name":"create","url":"classes/responsepredicate.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ResponsePredicate"},{"id":191,"kind":2048,"name":"errorConverter","url":"classes/responsepredicate.html#errorconverter","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResponsePredicate"},{"id":192,"kind":128,"name":"ResponsePredicateResult","url":"classes/responsepredicateresult.html","classes":"tsd-kind-class"},{"id":193,"kind":2048,"name":"success","url":"classes/responsepredicateresult.html#success","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ResponsePredicateResult"},{"id":194,"kind":2048,"name":"failure","url":"classes/responsepredicateresult.html#failure","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"ResponsePredicateResult"},{"id":195,"kind":2048,"name":"succeeded","url":"classes/responsepredicateresult.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResponsePredicateResult"},{"id":196,"kind":2048,"name":"message","url":"classes/responsepredicateresult.html#message","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResponsePredicateResult"},{"id":197,"kind":2048,"name":"response","url":"classes/responsepredicateresult.html#response","classes":"tsd-kind-method tsd-parent-kind-class","parent":"ResponsePredicateResult"},{"id":198,"kind":128,"name":"WebClient","url":"classes/webclient.html","classes":"tsd-kind-class"},{"id":199,"kind":2048,"name":"create","url":"classes/webclient.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebClient"},{"id":200,"kind":2048,"name":"wrap","url":"classes/webclient.html#wrap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"WebClient"},{"id":201,"kind":2048,"name":"request","url":"classes/webclient.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":202,"kind":2048,"name":"requestAbs","url":"classes/webclient.html#requestabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":203,"kind":2048,"name":"get","url":"classes/webclient.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":204,"kind":2048,"name":"getAbs","url":"classes/webclient.html#getabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":205,"kind":2048,"name":"post","url":"classes/webclient.html#post","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":206,"kind":2048,"name":"postAbs","url":"classes/webclient.html#postabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":207,"kind":2048,"name":"put","url":"classes/webclient.html#put","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":208,"kind":2048,"name":"putAbs","url":"classes/webclient.html#putabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":209,"kind":2048,"name":"delete","url":"classes/webclient.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":210,"kind":2048,"name":"deleteAbs","url":"classes/webclient.html#deleteabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":211,"kind":2048,"name":"patch","url":"classes/webclient.html#patch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":212,"kind":2048,"name":"patchAbs","url":"classes/webclient.html#patchabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":213,"kind":2048,"name":"head","url":"classes/webclient.html#head","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":214,"kind":2048,"name":"headAbs","url":"classes/webclient.html#headabs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"},{"id":215,"kind":2048,"name":"close","url":"classes/webclient.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"WebClient"}]}; \ No newline at end of file diff --git a/docs/@vertx/web-client/classes/errorconverter.html b/docs/@vertx/web-client/classes/errorconverter.html new file mode 100644 index 000000000..bd34a9979 --- /dev/null +++ b/docs/@vertx/web-client/classes/errorconverter.html @@ -0,0 +1,358 @@ + + + + + + ErrorConverter | @vertx/web-client + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class ErrorConverter

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + ErrorConverter +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    apply

    + + +
    +
    + +

    requiresBody

    +
      +
    • requiresBody(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      when the converter wants to process the request body.

      +
      • +
    +
    +
    + +

    Static create

    + +
      +
    • + +
      +
      +

      Creates a full ErrorConverter, that will passed a predicate result with the response body.

      +
      +

      The {@code converter} function will be invoked after the HTTP response body is received. +

      +

      Parameters

      + +

      Returns ErrorConverter

      +
      • +
    +
    +
    + +

    Static createFullBody

    + +
      +
    • + +
      +
      +

      Creates a full ErrorConverter, that will passed a predicate result with the response body.

      +
      +

      The {@code converter} function will be invoked after the HTTP response body is received. +

      +

      Parameters

      + +

      Returns ErrorConverter

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/web-client/classes/httprequest.html b/docs/@vertx/web-client/classes/httprequest.html index 553e9f9cd..6b7f716ac 100644 --- a/docs/@vertx/web-client/classes/httprequest.html +++ b/docs/@vertx/web-client/classes/httprequest.html @@ -57,13 +57,21 @@ HttpRequest -

    Class HttpRequest

    +

    Class HttpRequest<T>

    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Hierarchy

    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    -
    +

    as

    -
      -
    • as(responseCodec: BodyCodec): HttpRequest
      • +
      • -

        Configure the request to decode the response with the {@code responseCodec}.

        +

        Configure the request to decode the response with the {@code responseCodec}.

        +

        Type parameters

        +
          +
        • +

          U

          +
          • +

        Parameters

        • -
          responseCodec: BodyCodec
          +
          responseCodec: BodyCodec<U>

          the response codec

        -

        Returns HttpRequest

        +

        Returns HttpRequest<U>

        a reference to this, so the API can be used fluently

      @@ -181,41 +197,119 @@

      Returns

      copy

      • -

        Copy this request

        +

        Copy this request

        -

        Returns HttpRequest

        +

        Returns HttpRequest<T>

        a copy of this request

    +
    + +

    expect

    + +
      +
    • + +
      +
      +

      Add an expectation that the response is valid according to the provided {@code predicate}. +

      + Multiple predicates can be added.

      +
      +
      +

      Parameters

      + +

      Returns HttpRequest<T>

      +

      a reference to this, so the API can be used fluently

      +
      • +
    • + +
      +
      +

      Add an expectation that the response is valid according to the provided {@code predicate}. +

      + Multiple predicates can be added.

      +
      +
      +

      Parameters

      + +

      Returns HttpRequest<T>

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +

    followRedirects

    • -

      Set wether or not to follow the directs for the request.

      +

      Set wether or not to follow the directs for the request.

      Parameters

      @@ -227,7 +321,7 @@
      value: boolean
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -242,7 +336,7 @@

    headers

  • @@ -256,18 +350,18 @@

    Returns MultiMap<

    host

    • -

      Configure the request to use a new host {@code value}.

      +

      Configure the request to use a new host {@code value}.

      Parameters

      @@ -276,7 +370,7 @@

      Parameters

      value: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    • @@ -285,18 +379,18 @@

    Returns

    method

    • -

      Configure the request to use a new method {@code value}.

      +

      Configure the request to use a new method {@code value}.

      Parameters

      @@ -305,7 +399,7 @@

      Parameters

      value: HttpMethod
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -314,18 +408,18 @@

    Returns

    port

    • -

      Configure the request to use a new port {@code value}.

      +

      Configure the request to use a new port {@code value}.

      Parameters

      @@ -334,7 +428,7 @@

      Parameters

      value: number
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -343,18 +437,18 @@

    Returns

    putHeader

      -
    • putHeader(name: string, value: string): HttpRequest
      • +
    • putHeader(name: string, value: string): HttpRequest<T>
    • -

      Configure the request to add a new HTTP header.

      +

      Configure the request to add a new HTTP header.

      Parameters

      @@ -372,7 +466,7 @@
      value: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -387,12 +481,12 @@

    queryParams

  • -

    Return the current query parameters.

    +

    Return the current query parameters.

    Returns MultiMap

    @@ -410,12 +504,12 @@

    send

  • -

    Send a request, the {@code handler} will receive the response as an HttpResponse.

    +

    Send a request, the {@code handler} will receive the response as an HttpResponse.

    Parameters

    @@ -425,17 +519,20 @@
    handler: function
      • @@ -456,12 +553,12 @@

      sendBuffer

    • -

      Like {@link #send(Handler)} but with an HTTP request {@code body} buffer.

      +

      Like {@link #send(Handler)} but with an HTTP request {@code body} buffer.

      Parameters

      @@ -477,17 +574,20 @@
      handler: function
        • @@ -508,12 +608,12 @@

        sendForm

      • -

        Like {@link #send(Handler)} but with an HTTP request {@code body} multimap encoded as form and the content type +

        Like {@link #send(Handler)} but with an HTTP request {@code body} multimap encoded as form and the content type set to {@code application/x-www-form-urlencoded}.

        When the content type header is previously set to {@code multipart/form-data} it will be used instead.

        @@ -532,17 +632,20 @@
        handler: function
          • @@ -563,12 +666,12 @@

          sendJson

        • -

          Like {@link #send(Handler)} but with an HTTP request {@code body} object encoded as json and the content type +

          Like {@link #send(Handler)} but with an HTTP request {@code body} object encoded as json and the content type set to {@code application/json}.

          @@ -585,17 +688,20 @@
          handler: function
            • @@ -616,12 +722,12 @@

            sendJsonObject

          • -

            Like {@link #send(Handler)} but with an HTTP request {@code body} object encoded as json and the content type +

            Like {@link #send(Handler)} but with an HTTP request {@code body} object encoded as json and the content type set to {@code application/json}.

            @@ -632,23 +738,87 @@
            body: object

            the body

            +
              +
            • +
              [key: string]: any
              +
              • +
          • handler: function
            +
            • +
          +

          Returns void

          +
          • +
        +
    • +
    + +

    sendMultipartForm

    +
      +
    • sendMultipartForm(body: MultipartForm, handler: function): void
      • +
    +
      +
    • + +
      +
      +

      Like {@link #send(Handler)} but with an HTTP request {@code body} multimap encoded as form and the content type + set to {@code multipart/form-data}. You may use this method to send attributes and upload files.

      +
      +
      +

      Parameters

      +
        +
      • +
        body: MultipartForm
        +
        +

        the body

        +
        +
        • +
      • +
        handler: function
        +
          +
        • + +
            +
          • +

            Parameters

            + +

            Returns void + | + Handler<AsyncResult<HttpResponse<T>>> +

          • @@ -663,24 +833,24 @@

          Returns void

          sendStream

            -
          • sendStream(body: ReadStream, handler: function): void
            • +
          • sendStream(body: ReadStream<Buffer>, handler: function): void
          • -

            Like {@link #send(Handler)} but with an HTTP request {@code body} stream.

            +

            Like {@link #send(Handler)} but with an HTTP request {@code body} stream.

            Parameters

            • -
              body: ReadStream
              +
              body: ReadStream<Buffer>

              the body

              @@ -690,17 +860,20 @@
              handler: function
                • @@ -715,18 +888,18 @@

                Returns void

                setQueryParam

                  -
                • setQueryParam(paramName: string, paramValue: string): HttpRequest
                  • +
                • setQueryParam(paramName: string, paramValue: string): HttpRequest<T>
                • -

                  Set a query parameter to the request.

                  +

                  Set a query parameter to the request.

                  Parameters

                  @@ -744,7 +917,7 @@
                  paramValue: string
                -

                Returns HttpRequest

                +

                Returns HttpRequest<T>

                a reference to this, so the API can be used fluently

              @@ -753,13 +926,13 @@

              Returns

              ssl

              • Parameters

                @@ -768,7 +941,7 @@

                Parameters

                value: boolean
              -

              Returns HttpRequest

              +

              Returns HttpRequest<T>

    @@ -776,18 +949,18 @@

    Returns

    timeout

    • -

      Configures the amount of time in milliseconds after which if the request does not return any data within the timeout +

      Configures the amount of time in milliseconds after which if the request does not return any data within the timeout period an {@link java.util.concurrent.TimeoutException} fails the request.

      Setting zero or a negative {@code value} disables the timeout.

      @@ -802,7 +975,7 @@
      value: number
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -811,18 +984,18 @@

    Returns

    uri

    • -

      Configure the request to use a new request URI {@code value}. +

      Configure the request to use a new request URI {@code value}.

      When the uri has query parameters, they are set in the {@link #queryParams()} multimap, overwritting any parameters previously set.

      @@ -834,7 +1007,7 @@

      Parameters

      value: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -843,18 +1016,18 @@

    Returns

    virtualHost

    • -

      Configure the request to use a virtual host {@code value}. +

      Configure the request to use a virtual host {@code value}.

      Usually the header host (:authority pseudo header for HTTP/2) is set from the request host value since this host value resolves to the server IP address. @@ -872,7 +1045,7 @@

      Parameters

      value: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<T>

    a reference to this, so the API can be used fluently

    @@ -889,20 +1062,26 @@

    Returns
      -
    • +
    • HttpRequest -

      Class HttpResponse

      +

      Class HttpResponse<T>

      +
      +

      Type parameters

      +
        +
      • +

        T

        +
        • +
      +

      Hierarchy

        @@ -81,7 +89,7 @@

        Methods

        • body
        • bodyAsBuffer
          • -
        • bodyAsJson
          • +
        • bodyAsJson
        • bodyAsJsonArray
        • bodyAsJsonObject
        • bodyAsString
          • @@ -104,18 +112,18 @@

          Methods

          body

            -
          • body(): Object | null
            • +
          • body(): T | null
          • -

            Returns Object +

            Returns T | null

            @@ -133,7 +141,7 @@

            bodyAsBuffer

          • @@ -142,36 +150,42 @@

            Returns Buffer | null

            -

            the response body decoded as a {@link Buffer}

            +

            the response body decoded as a {@link Buffer}, or {@code null} if a codec other than {@link BodyCodec#buffer()} was used

      -
      +

      bodyAsJson

      -
        -
      • bodyAsJson(type: Class): Object | null
        • +
          +
        • bodyAsJson<R>(type: any): R | null
        • +

          Type parameters

          +
            +
          • +

            R

            +
            • +

          Parameters

          • -
            type: Class
            +
            type: any
          -

          Returns Object +

          Returns R | null

          -

          the response body decoded as the specified {@code type} with the Jackson mapper.

          +

          the response body decoded as the specified {@code type} with the Jackson mapper, or {@code null} if a codec other than {@link BodyCodec#buffer()} was used

      @@ -185,7 +199,7 @@

      bodyAsJsonArray

    • @@ -194,7 +208,7 @@

      Returns any | null

      -

      the response body decoded as a json array

      +

      the response body decoded as a {@link JsonArray}, or {@code null} if a codec other than {@link BodyCodec#buffer()} was used

    @@ -202,22 +216,22 @@

    Returns any

    bodyAsJsonObject

      -
    • bodyAsJsonObject(): any | null
      • +
    • bodyAsJsonObject(): object | null
    • -

      Returns any +

      Returns object | null

      -

      the response body decoded as a json object

      +

      the response body decoded as {@link JsonObject}, or {@code null} if a codec other than {@link BodyCodec#buffer()} was used

    @@ -232,7 +246,7 @@

    bodyAsString

  • @@ -241,12 +255,12 @@

    Returns string | null

    -

    the response body decoded as a {@code String}

    +

    the response body decoded as a {@code String}, or {@code null} if a codec other than {@link BodyCodec#buffer()} was used

  • @@ -261,7 +275,7 @@

    Returns string | null

    -

    the response body decoded as a {@code String} given a specific {@code encoding}

    +

    the response body decoded as a {@code String} given a specific {@code encoding}, or {@code null} if a codec other than {@link BodyCodec#buffer()} was used

    • @@ -275,7 +289,7 @@

    cookies

  • @@ -295,12 +309,12 @@

    getHeader

  • -

    Return the first header value with the specified name

    +

    Return the first header value with the specified name

    Parameters

    @@ -330,12 +344,12 @@

    getTrailer

  • -

    Return the first trailer value with the specified name

    +

    Return the first trailer value with the specified name

    Parameters

    @@ -365,7 +379,7 @@

    headers

  • @@ -385,7 +399,7 @@

    statusCode

  • @@ -405,7 +419,7 @@

    statusMessage

  • @@ -425,7 +439,7 @@

    trailers

  • @@ -445,7 +459,7 @@

    version

  • @@ -468,11 +482,14 @@

    Returns HttpVersi

    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP DELETE request to send to the server at the specified host and port.

    +

    Create an HTTP DELETE request to send to the server at the specified host and port.

    Parameters

    @@ -190,18 +190,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP DELETE request to send to the server at the specified host and default port.

    +

    Create an HTTP DELETE request to send to the server at the specified host and default port.

    Parameters

    @@ -219,7 +219,7 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -228,18 +228,18 @@

    Returns

    deleteAbs

    • -

      Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive +

      Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response

      @@ -252,7 +252,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -261,20 +261,20 @@

    Returns

    get

      -
    • get(requestURI: string): HttpRequest
      • -
    • get(port: number, host: string, requestURI: string): HttpRequest
      • -
    • get(host: string, requestURI: string): HttpRequest
      • +
    • get(requestURI: string): HttpRequest<Buffer>
      • +
    • get(port: number, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • get(host: string, requestURI: string): HttpRequest<Buffer>
    • -

      Create an HTTP GET request to send to the server at the default host and port.

      +

      Create an HTTP GET request to send to the server at the default host and port.

      Parameters

      @@ -286,18 +286,18 @@
      requestURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP GET request to send to the server at the specified host and port.

    +

    Create an HTTP GET request to send to the server at the specified host and port.

    Parameters

    @@ -321,18 +321,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP GET request to send to the server at the specified host and default port.

    +

    Create an HTTP GET request to send to the server at the specified host and default port.

    Parameters

    @@ -350,7 +350,7 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -359,18 +359,18 @@

    Returns

    getAbs

    • -

      Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive +

      Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response

      @@ -383,7 +383,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -392,20 +392,20 @@

    Returns

    head

      -
    • head(requestURI: string): HttpRequest
      • -
    • head(port: number, host: string, requestURI: string): HttpRequest
      • -
    • head(host: string, requestURI: string): HttpRequest
      • +
    • head(requestURI: string): HttpRequest<Buffer>
      • +
    • head(port: number, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • head(host: string, requestURI: string): HttpRequest<Buffer>
    • -

      Create an HTTP HEAD request to send to the server at the default host and port.

      +

      Create an HTTP HEAD request to send to the server at the default host and port.

      Parameters

      @@ -417,18 +417,18 @@
      requestURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP HEAD request to send to the server at the specified host and port.

    +

    Create an HTTP HEAD request to send to the server at the specified host and port.

    Parameters

    @@ -452,18 +452,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP HEAD request to send to the server at the specified host and default port.

    +

    Create an HTTP HEAD request to send to the server at the specified host and default port.

    Parameters

    @@ -481,7 +481,7 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -490,18 +490,18 @@

    Returns

    headAbs

    • -

      Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive +

      Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response

      @@ -514,7 +514,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -523,20 +523,20 @@

    Returns

    patch

      -
    • patch(requestURI: string): HttpRequest
      • -
    • patch(port: number, host: string, requestURI: string): HttpRequest
      • -
    • patch(host: string, requestURI: string): HttpRequest
      • +
    • patch(requestURI: string): HttpRequest<Buffer>
      • +
    • patch(port: number, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • patch(host: string, requestURI: string): HttpRequest<Buffer>
    • -

      Create an HTTP PATCH request to send to the server at the default host and port.

      +

      Create an HTTP PATCH request to send to the server at the default host and port.

      Parameters

      @@ -548,18 +548,18 @@
      requestURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP PATCH request to send to the server at the specified host and port.

    +

    Create an HTTP PATCH request to send to the server at the specified host and port.

    Parameters

    @@ -583,18 +583,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP PATCH request to send to the server at the specified host and default port.

    +

    Create an HTTP PATCH request to send to the server at the specified host and default port.

    Parameters

    @@ -612,7 +612,7 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -621,18 +621,18 @@

    Returns

    patchAbs

    • -

      Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive +

      Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive the response

      @@ -645,7 +645,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -654,20 +654,20 @@

    Returns

    post

      -
    • post(requestURI: string): HttpRequest
      • -
    • post(port: number, host: string, requestURI: string): HttpRequest
      • -
    • post(host: string, requestURI: string): HttpRequest
      • +
    • post(requestURI: string): HttpRequest<Buffer>
      • +
    • post(port: number, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • post(host: string, requestURI: string): HttpRequest<Buffer>
    • -

      Create an HTTP POST request to send to the server at the default host and port.

      +

      Create an HTTP POST request to send to the server at the default host and port.

      Parameters

      @@ -679,18 +679,18 @@
      requestURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP POST request to send to the server at the specified host and port.

    +

    Create an HTTP POST request to send to the server at the specified host and port.

    Parameters

    @@ -714,18 +714,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP POST request to send to the server at the specified host and default port.

    +

    Create an HTTP POST request to send to the server at the specified host and default port.

    Parameters

    @@ -743,7 +743,7 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -752,18 +752,18 @@

    Returns

    postAbs

    • -

      Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive +

      Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response

      @@ -776,7 +776,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -785,20 +785,20 @@

    Returns

    put

      -
    • put(requestURI: string): HttpRequest
      • -
    • put(port: number, host: string, requestURI: string): HttpRequest
      • -
    • put(host: string, requestURI: string): HttpRequest
      • +
    • put(requestURI: string): HttpRequest<Buffer>
      • +
    • put(port: number, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • put(host: string, requestURI: string): HttpRequest<Buffer>
    • -

      Create an HTTP PUT request to send to the server at the default host and port.

      +

      Create an HTTP PUT request to send to the server at the default host and port.

      Parameters

      @@ -810,18 +810,18 @@
      requestURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP PUT request to send to the server at the specified host and port.

    +

    Create an HTTP PUT request to send to the server at the specified host and port.

    Parameters

    @@ -845,18 +845,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP PUT request to send to the server at the specified host and default port.

    +

    Create an HTTP PUT request to send to the server at the specified host and default port.

    Parameters

    @@ -874,7 +874,7 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -883,18 +883,18 @@

    Returns

    putAbs

    • -

      Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive +

      Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response

      @@ -907,7 +907,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -916,21 +916,21 @@

    Returns

    request

      -
    • request(method: HttpMethod, port: number, host: string, requestURI: string): HttpRequest
      • -
    • request(method: HttpMethod, host: string, requestURI: string): HttpRequest
      • -
    • request(method: HttpMethod, requestURI: string): HttpRequest
      • -
    • request(method: HttpMethod, options: RequestOptions): HttpRequest
      • +
    • request(method: HttpMethod, port: number, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • request(method: HttpMethod, host: string, requestURI: string): HttpRequest<Buffer>
      • +
    • request(method: HttpMethod, requestURI: string): HttpRequest<Buffer>
      • +
    • request(method: HttpMethod, options: RequestOptions): HttpRequest<Buffer>
    • -

      Create an HTTP request to send to the server at the specified host and port.

      +

      Create an HTTP request to send to the server at the specified host and port.

      Parameters

      @@ -960,18 +960,18 @@
      requestURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP request to send to the server at the specified host and default port.

    +

    Create an HTTP request to send to the server at the specified host and default port.

    Parameters

    @@ -995,18 +995,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP request to send to the server at the default host and port.

    +

    Create an HTTP request to send to the server at the default host and port.

    Parameters

    @@ -1024,18 +1024,18 @@
    requestURI: string
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

  • -

    Create an HTTP request to send to the server at the specified host and port.

    +

    Create an HTTP request to send to the server at the specified host and port.

    Parameters

    @@ -1053,7 +1053,7 @@
    options: RequestOptions
    • -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -1062,18 +1062,18 @@

    Returns

    requestAbs

      -
    • requestAbs(method: HttpMethod, absoluteURI: string): HttpRequest
      • +
    • requestAbs(method: HttpMethod, absoluteURI: string): HttpRequest<Buffer>
    • -

      Create an HTTP request to send to the server using an absolute URI

      +

      Create an HTTP request to send to the server using an absolute URI

      Parameters

      @@ -1091,7 +1091,7 @@
      absoluteURI: string
    -

    Returns HttpRequest

    +

    Returns HttpRequest<Buffer>

    an HTTP client request object

    @@ -1107,12 +1107,12 @@

    Static create

  • -

    Create a web client using the provided {@code vertx} instance and default options.

    +

    Create a web client using the provided {@code vertx} instance and default options.

    Parameters

    @@ -1130,12 +1130,12 @@

    Returns
    -

    Create a web client using the provided {@code vertx} instance.

    +

    Create a web client using the provided {@code vertx} instance.

    Parameters

    @@ -1169,12 +1169,12 @@

    Static wrap

  • -

    Wrap an {@code httpClient} with a web client and default options.

    +

    Wrap an {@code httpClient} with a web client and default options.

    Parameters

    @@ -1192,12 +1192,12 @@

    Returns
    -

    Wrap an {@code httpClient} with a web client and default options. +

    Wrap an {@code httpClient} with a web client and default options.

    Only the specific web client portion of the {@code options} is used, the {@link io.vertx.core.http.HttpClientOptions} of the {@code httpClient} is reused.

    @@ -1236,11 +1236,20 @@

    Returns

    • -

    Properties

    -
    - -

    alpnVersions

    -
    alpnVersions: HttpVersion
    - +

    Constructors

    +
    + +

    constructor

    + +
    -
    - -

    connectTimeout

    -
    connectTimeout: number
    - +
    +
    +

    Methods

    +
    + +

    addCrlPath

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlPaths: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    crlPaths

    -
    crlPaths: string
    - +
    + +

    addCrlValue

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        crlValues: Buffer
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    crlValues

    -
    crlValues: Buffer
    - +
    + +

    addEnabledCipherSuite

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledCipherSuites: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    decoderInitialBufferSize

    -
    decoderInitialBufferSize: number
    - +
    + +

    addEnabledSecureTransportProtocol

    +
      +
    • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    defaultHost

    -
    defaultHost: string
    - +
    + +

    getAlpnVersions

    +
      +
    • getAlpnVersions(): HttpVersion
      • +
    +
      +
    • + +

      Returns HttpVersion

      +
      • +
    -
    - -

    defaultPort

    -
    defaultPort: number
    - +
    + +

    getConnectTimeout

    +
      +
    • getConnectTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    enabledCipherSuites

    -
    enabledCipherSuites: string
    - +
    + +

    getCrlPaths

    +
      +
    • getCrlPaths(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    enabledSecureTransportProtocols

    -
    enabledSecureTransportProtocols: string
    - +
    + +

    getCrlValues

    +
      +
    • getCrlValues(): Buffer
      • +
    +
      +
    • + +

      Returns Buffer

      +
      • +
    -
    - -

    followRedirects

    -
    followRedirects: boolean
    - -
    -
    -

    Configure the default behavior of the client to follow HTTP {@code 30x} redirections.

    -
    -
    -
    param
    -

    true when a redirect is followed

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    getDecoderInitialBufferSize

    +
      +
    • getDecoderInitialBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    forceSni

    -
    forceSni: boolean
    - +
    + +

    getDefaultHost

    +
      +
    • getDefaultHost(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2ClearTextUpgrade

    -
    http2ClearTextUpgrade: boolean
    - +
    + +

    getDefaultPort

    +
      +
    • getDefaultPort(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    http2ConnectionWindowSize

    -
    http2ConnectionWindowSize: number
    - +
    + +

    getEnabledCipherSuites

    +
      +
    • getEnabledCipherSuites(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2KeepAliveTimeout

    -
    http2KeepAliveTimeout: number
    - +
    + +

    getEnabledSecureTransportProtocols

    +
      +
    • getEnabledSecureTransportProtocols(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    http2MaxPoolSize

    -
    http2MaxPoolSize: number
    - +
    + +

    getHttp2ConnectionWindowSize

    +
      +
    • getHttp2ConnectionWindowSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    http2MultiplexingLimit

    -
    http2MultiplexingLimit: number
    - +
    + +

    getHttp2KeepAliveTimeout

    +
      +
    • getHttp2KeepAliveTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    idleTimeout

    -
    idleTimeout: number
    - +
    + +

    getHttp2MaxPoolSize

    +
      +
    • getHttp2MaxPoolSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    initialSettings

    -
    initialSettings: Http2Settings
    - +
    + +

    getHttp2MultiplexingLimit

    +
      +
    • getHttp2MultiplexingLimit(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    jdkSslEngineOptions

    -
    jdkSslEngineOptions: JdkSSLEngineOptions
    - +
    + +

    getIdleTimeout

    +
      +
    • getIdleTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    keepAlive

    -
    keepAlive: boolean
    - +
    + +

    getIdleTimeoutUnit

    +
      +
    • getIdleTimeoutUnit(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    -
    - -

    keepAliveTimeout

    -
    keepAliveTimeout: number
    - +
    + +

    getInitialSettings

    +
      +
    • getInitialSettings(): Http2Settings
      • +
    +
      +
    • + +

      Returns Http2Settings

      +
      • +
    -
    - -

    keyStoreOptions

    -
    keyStoreOptions: JksOptions
    - +
    + +

    getJdkSslEngineOptions

    +
      +
    • getJdkSslEngineOptions(): JdkSSLEngineOptions
      • +
    +
      +
    • + +

      Returns JdkSSLEngineOptions

      +
      • +
    -
    - -

    localAddress

    -
    localAddress: string
    - +
    + +

    getKeepAliveTimeout

    +
      +
    • getKeepAliveTimeout(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    logActivity

    -
    logActivity: boolean
    - +
    + +

    getKeyStoreOptions

    +
      +
    • getKeyStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    -
    - -

    maxChunkSize

    -
    maxChunkSize: number
    - +
    + +

    getLocalAddress

    +
      +
    • getLocalAddress(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    maxHeaderSize

    -
    maxHeaderSize: number
    - +
    + +

    getLogActivity

    +
      +
    • getLogActivity(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    maxInitialLineLength

    -
    maxInitialLineLength: number
    - +
    + +

    getMaxChunkSize

    +
      +
    • getMaxChunkSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxPoolSize

    -
    maxPoolSize: number
    - +
    + +

    getMaxHeaderSize

    +
      +
    • getMaxHeaderSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxRedirects

    -
    maxRedirects: number
    - +
    + +

    getMaxInitialLineLength

    +
      +
    • getMaxInitialLineLength(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWaitQueueSize

    -
    maxWaitQueueSize: number
    - +
    + +

    getMaxPoolSize

    +
      +
    • getMaxPoolSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWebsocketFrameSize

    -
    maxWebsocketFrameSize: number
    - +
    + +

    getMaxRedirects

    +
      +
    • getMaxRedirects(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    maxWebsocketMessageSize

    -
    maxWebsocketMessageSize: number
    - +
    + +

    getMaxWaitQueueSize

    +
      +
    • getMaxWaitQueueSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    metricsName

    -
    metricsName: string
    - +
    + +

    getMaxWebsocketFrameSize

    +
      +
    • getMaxWebsocketFrameSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    openSslEngineOptions

    -
    openSslEngineOptions: OpenSSLEngineOptions
    - +
    + +

    getMaxWebsocketMessageSize

    +
      +
    • getMaxWebsocketMessageSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    -
    - -

    pemKeyCertOptions

    -
    pemKeyCertOptions: PemKeyCertOptions
    - +
    + +

    getMetricsName

    +
      +
    • getMetricsName(): string
      • +
    +
      +
    • + +

      Returns string

      +
      • +
    -
    - -

    pemTrustOptions

    -
    pemTrustOptions: PemTrustOptions
    - +
    + +

    getOpenSslEngineOptions

    +
      +
    • getOpenSslEngineOptions(): OpenSSLEngineOptions
      • +
    +
      +
    • + +

      Returns OpenSSLEngineOptions

      +
      • +
    +
    +
    + +

    getPemKeyCertOptions

    +
      +
    • getPemKeyCertOptions(): PemKeyCertOptions
      • +
    +
      +
    • + +

      Returns PemKeyCertOptions

      +
      • +
    +
    +
    + +

    getPemTrustOptions

    +
      +
    • getPemTrustOptions(): PemTrustOptions
      • +
    +
      +
    • + +

      Returns PemTrustOptions

      +
      • +
    +
    +
    + +

    getPfxKeyCertOptions

    +
      +
    • getPfxKeyCertOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPfxTrustOptions

    +
      +
    • getPfxTrustOptions(): PfxOptions
      • +
    +
      +
    • + +

      Returns PfxOptions

      +
      • +
    +
    +
    + +

    getPipeliningLimit

    +
      +
    • getPipeliningLimit(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getPoolCleanerPeriod

    +
      +
    • getPoolCleanerPeriod(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getProtocolVersion

    +
      +
    • getProtocolVersion(): HttpVersion
      • +
    +
      +
    • + +

      Returns HttpVersion

      +
      • +
    +
    +
    + +

    getProxyOptions

    +
      +
    • getProxyOptions(): ProxyOptions
      • +
    +
      +
    • + +

      Returns ProxyOptions

      +
      • +
    +
    +
    + +

    getReceiveBufferSize

    +
      +
    • getReceiveBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSendBufferSize

    +
      +
    • getSendBufferSize(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getSoLinger

    +
      +
    • getSoLinger(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrafficClass

    +
      +
    • getTrafficClass(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getTrustStoreOptions

    +
      +
    • getTrustStoreOptions(): JksOptions
      • +
    +
      +
    • + +

      Returns JksOptions

      +
      • +
    +
    +
    + +

    getUserAgent

    +
      +
    • getUserAgent(): string
      • +
    +
      +
    • + +
      +
      +

      Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

      +
      +
      +

      Returns string

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    getWebsocketCompressionAllowClientNoContext

    +
      +
    • getWebsocketCompressionAllowClientNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    getWebsocketCompressionLevel

    +
      +
    • getWebsocketCompressionLevel(): number
      • +
    +
      +
    • + +

      Returns number

      +
      • +
    +
    +
    + +

    getWebsocketCompressionRequestServerNoContext

    +
      +
    • getWebsocketCompressionRequestServerNoContext(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isFollowRedirects

    +
      +
    • isFollowRedirects(): boolean
      • +
    +
      +
    • + +
      +
      +

      Configure the default behavior of the client to follow HTTP {@code 30x} redirections.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isForceSni

    +
      +
    • isForceSni(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isHttp2ClearTextUpgrade

    +
      +
    • isHttp2ClearTextUpgrade(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isKeepAlive

    +
      +
    • isKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isPipelining

    +
      +
    • isPipelining(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReuseAddress

    +
      +
    • isReuseAddress(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isReusePort

    +
      +
    • isReusePort(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSendUnmaskedFrames

    +
      +
    • isSendUnmaskedFrames(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSsl

    +
      +
    • isSsl(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpCork

    +
      +
    • isTcpCork(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpFastOpen

    +
      +
    • isTcpFastOpen(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpKeepAlive

    +
      +
    • isTcpKeepAlive(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpNoDelay

    +
      +
    • isTcpNoDelay(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTcpQuickAck

    +
      +
    • isTcpQuickAck(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTrustAll

    +
      +
    • isTrustAll(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isTryUseCompression

    +
      +
    • isTryUseCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUseAlpn

    +
      +
    • isUseAlpn(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUsePooledBuffers

    +
      +
    • isUsePooledBuffers(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    isUserAgentEnabled

    +
      +
    • isUserAgentEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Sets whether the Web Client should send a user agent header. Defaults to true.

      +
      +
      +

      Returns boolean

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    isVerifyHost

    +
      +
    • isVerifyHost(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    +
    +
    + +

    setAlpnVersions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        alpnVersions: HttpVersion
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setConnectTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        connectTimeout: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setDecoderInitialBufferSize

    +
      +
    • setDecoderInitialBufferSize(decoderInitialBufferSize: number): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        decoderInitialBufferSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setDefaultHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        defaultHost: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setDefaultPort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        defaultPort: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setEnabledSecureTransportProtocols

    +
      +
    • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        enabledSecureTransportProtocols: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setFollowRedirects

    + +
      +
    • + +
      +
      +

      Configure the default behavior of the client to follow HTTP {@code 30x} redirections.

      +
      +
      +

      Parameters

      +
        +
      • +
        followRedirects: boolean
        +
        +

        true when a redirect is followed

        +
        +
        • +
      +

      Returns WebClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    setForceSni

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        forceSni: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setHttp2ClearTextUpgrade

    +
      +
    • setHttp2ClearTextUpgrade(http2ClearTextUpgrade: boolean): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        http2ClearTextUpgrade: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setHttp2ConnectionWindowSize

    +
      +
    • setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        http2ConnectionWindowSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setHttp2KeepAliveTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2KeepAliveTimeout: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setHttp2MaxPoolSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        http2MaxPoolSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setHttp2MultiplexingLimit

    +
      +
    • setHttp2MultiplexingLimit(http2MultiplexingLimit: number): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        http2MultiplexingLimit: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setIdleTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeout: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setIdleTimeoutUnit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        idleTimeoutUnit: any
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setInitialSettings

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        initialSettings: Http2Settings
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setJdkSslEngineOptions

    +
      +
    • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        jdkSslEngineOptions: JdkSSLEngineOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keepAlive: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setKeepAliveTimeout

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keepAliveTimeout: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setKeyStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        keyStoreOptions: JksOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setLocalAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        localAddress: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setLogActivity

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        logActivity: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxChunkSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxChunkSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxHeaderSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxHeaderSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxInitialLineLength

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxInitialLineLength: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxPoolSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxPoolSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxRedirects

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxRedirects: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxWaitQueueSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWaitQueueSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxWebsocketFrameSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWebsocketFrameSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMaxWebsocketMessageSize

    +
      +
    • setMaxWebsocketMessageSize(maxWebsocketMessageSize: number): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        maxWebsocketMessageSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setMetricsName

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        metricsName: string
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setOpenSslEngineOptions

    +
      +
    • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        openSslEngineOptions: OpenSSLEngineOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPemKeyCertOptions

    +
      +
    • setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pemKeyCertOptions: PemKeyCertOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPemTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pemTrustOptions: PemTrustOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPfxKeyCertOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxKeyCertOptions: PfxOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPfxTrustOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pfxTrustOptions: PfxOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPipelining

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pipelining: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPipeliningLimit

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        pipeliningLimit: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setPoolCleanerPeriod

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        poolCleanerPeriod: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setProtocolVersion

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        protocolVersion: HttpVersion
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    +
    +
    + +

    setProxyOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        proxyOptions: ProxyOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    pfxKeyCertOptions

    -
    pfxKeyCertOptions: PfxOptions
    - +
    + +

    setReceiveBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        receiveBufferSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    pfxTrustOptions

    -
    pfxTrustOptions: PfxOptions
    - +
    + +

    setReuseAddress

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reuseAddress: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    pipelining

    -
    pipelining: boolean
    - +
    + +

    setReusePort

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        reusePort: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    pipeliningLimit

    -
    pipeliningLimit: number
    - +
    + +

    setSendBufferSize

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendBufferSize: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    poolCleanerPeriod

    -
    poolCleanerPeriod: number
    - +
    + +

    setSendUnmaskedFrames

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        sendUnmaskedFrames: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    protocolVersion

    -
    protocolVersion: HttpVersion
    - +
    + +

    setSoLinger

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        soLinger: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    proxyOptions

    -
    proxyOptions: ProxyOptions
    - +
    + +

    setSsl

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        ssl: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    receiveBufferSize

    -
    receiveBufferSize: number
    - +
    + +

    setTcpCork

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpCork: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    reuseAddress

    -
    reuseAddress: boolean
    - +
    + +

    setTcpFastOpen

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpFastOpen: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    reusePort

    -
    reusePort: boolean
    - +
    + +

    setTcpKeepAlive

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpKeepAlive: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    sendBufferSize

    -
    sendBufferSize: number
    - +
    + +

    setTcpNoDelay

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpNoDelay: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    sendUnmaskedFrames

    -
    sendUnmaskedFrames: boolean
    - +
    + +

    setTcpQuickAck

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tcpQuickAck: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    soLinger

    -
    soLinger: number
    - +
    + +

    setTrafficClass

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trafficClass: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    ssl

    -
    ssl: boolean
    - +
    + +

    setTrustAll

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustAll: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    tcpCork

    -
    tcpCork: boolean
    - +
    + +

    setTrustStoreOptions

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        trustStoreOptions: JksOptions
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    tcpFastOpen

    -
    tcpFastOpen: boolean
    - +
    + +

    setTryUseCompression

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUseCompression: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    tcpKeepAlive

    -
    tcpKeepAlive: boolean
    - +
    + +

    setTryUsePerFrameWebsocketCompression

    +
      +
    • setTryUsePerFrameWebsocketCompression(tryUsePerFrameWebsocketCompression: boolean): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUsePerFrameWebsocketCompression: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    tcpNoDelay

    -
    tcpNoDelay: boolean
    - +
    + +

    setTryUsePerMessageWebsocketCompression

    +
      +
    • setTryUsePerMessageWebsocketCompression(tryUsePerMessageWebsocketCompression: boolean): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        tryUsePerMessageWebsocketCompression: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    tcpQuickAck

    -
    tcpQuickAck: boolean
    - +
    + +

    setUseAlpn

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        useAlpn: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    trafficClass

    -
    trafficClass: number
    - +
    + +

    setUsePooledBuffers

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        usePooledBuffers: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    trustAll

    -
    trustAll: boolean
    - +
    + +

    setUserAgent

    + +
      +
    • + +
      +
      +

      Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

      +
      +
      +

      Parameters

      +
        +
      • +
        userAgent: string
        +
        +

        user agent header value

        +
        +
        • +
      +

      Returns WebClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    trustStoreOptions

    -
    trustStoreOptions: JksOptions
    - +
    + +

    setUserAgentEnabled

    + +
      +
    • + +
      +
      +

      Sets whether the Web Client should send a user agent header. Defaults to true.

      +
      +
      +

      Parameters

      +
        +
      • +
        userAgentEnabled: boolean
        +
        +

        true to send a user agent header, false otherwise

        +
        +
        • +
      +

      Returns WebClientOptions

      +

      a reference to this, so the API can be used fluently

      +
      • +
    -
    - -

    tryUseCompression

    -
    tryUseCompression: boolean
    - +
    + +

    setVerifyHost

    + +
      +
    • + +

      Parameters

      +
        +
      • +
        verifyHost: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    useAlpn

    -
    useAlpn: boolean
    - +
    + +

    setWebsocketCompressionAllowClientNoContext

    +
      +
    • setWebsocketCompressionAllowClientNoContext(websocketCompressionAllowClientNoContext: boolean): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionAllowClientNoContext: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    usePooledBuffers

    -
    usePooledBuffers: boolean
    - +
    + +

    setWebsocketCompressionLevel

    +
      +
    • setWebsocketCompressionLevel(websocketCompressionLevel: number): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionLevel: number
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    userAgent

    -
    userAgent: string
    - -
    -
    -

    Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

    -
    -
    -
    param
    -

    user agent header value

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    setWebsocketCompressionRequestServerNoContext

    +
      +
    • setWebsocketCompressionRequestServerNoContext(websocketCompressionRequestServerNoContext: boolean): WebClientOptions
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        websocketCompressionRequestServerNoContext: boolean
        +
        • +
      +

      Returns WebClientOptions

      +
      • +
    -
    - -

    userAgentEnabled

    -
    userAgentEnabled: boolean
    - -
    -
    -

    Sets whether the Web Client should send a user agent header. Defaults to true.

    -
    -
    -
    param
    -

    true to send a user agent header, false otherwise

    -
    -
    returns
    -

    a reference to this, so the API can be used fluently

    -
    -
    -
    +
    + +

    tryUsePerFrameWebsocketCompression

    +
      +
    • tryUsePerFrameWebsocketCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    -
    - -

    verifyHost

    -
    verifyHost: boolean
    - +
    + +

    tryUsePerMessageWebsocketCompression

    +
      +
    • tryUsePerMessageWebsocketCompression(): boolean
      • +
    +
      +
    • + +

      Returns boolean

      +
      • +
    @@ -842,11 +3149,20 @@

    verifyHost

    diff --git a/docs/@vertx/web-common/classes/formdatapart.html b/docs/@vertx/web-common/classes/formdatapart.html new file mode 100644 index 000000000..5dad8ca7a --- /dev/null +++ b/docs/@vertx/web-common/classes/formdatapart.html @@ -0,0 +1,382 @@ + + + + + + FormDataPart | @vertx/web-common + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class FormDataPart

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + FormDataPart +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    filename

    +
      +
    • filename(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the filename when this part is a file upload otherwise {@code null}

      +
      • +
    +
    +
    + +

    isAttribute

    +
      +
    • isAttribute(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      when this part is an attribute

      +
      • +
    +
    +
    + +

    isFileUpload

    +
      +
    • isFileUpload(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      when this part is a file upload

      +
      • +
    +
    +
    + +

    isText

    +
      +
    • isText(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns boolean

      +

      whether the file upload is text or binary when this part is a file upload otherwise {@code null}

      +
      • +
    +
    +
    + +

    mediaType

    +
      +
    • mediaType(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the media type when this part is a file upload otherwise {@code null}

      +
      • +
    +
    +
    + +

    name

    +
      +
    • name(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the name

      +
      • +
    +
    +
    + +

    pathname

    +
      +
    • pathname(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the pathname when this part is a file upload otherwise {@code null}

      +
      • +
    +
    +
    + +

    value

    +
      +
    • value(): string
      • +
    +
      +
    • + +
      +
      +

      Returns string

      +

      the value when the part for a form attribute otherwise {@code null}

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/web-common/classes/multipartform.html b/docs/@vertx/web-common/classes/multipartform.html new file mode 100644 index 000000000..9b8a4649f --- /dev/null +++ b/docs/@vertx/web-common/classes/multipartform.html @@ -0,0 +1,364 @@ + + + + + + MultipartForm | @vertx/web-common + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class MultipartForm

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + MultipartForm +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Methods

    +
    + +

    attribute

    + +
      +
    • + +
      +
      +

      Add an attribute form data part.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        the name of the attribute

        +
        +
        • +
      • +
        value: string
        +
        +

        the value of the attribute

        +
        +
        • +
      +

      Returns MultipartForm

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    binaryFileUpload

    +
      +
    • binaryFileUpload(name: string, filename: string, pathname: string, mediaType: string): MultipartForm
      • +
    +
      +
    • + +
      +
      +

      Add a binary file upload form data part.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of the parameter

        +
        +
        • +
      • +
        filename: string
        +
        +

        filename of the file

        +
        +
        • +
      • +
        pathname: string
        +
        +

        the pathname of the file

        +
        +
        • +
      • +
        mediaType: string
        +
        +

        the MIME type of the file

        +
        +
        • +
      +

      Returns MultipartForm

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    textFileUpload

    +
      +
    • textFileUpload(name: string, filename: string, pathname: string, mediaType: string): MultipartForm
      • +
    +
      +
    • + +
      +
      +

      Add a text file upload form data part.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        name of the parameter

        +
        +
        • +
      • +
        filename: string
        +
        +

        filename of the file

        +
        +
        • +
      • +
        pathname: string
        +
        +

        the pathname of the file

        +
        +
        • +
      • +
        mediaType: string
        +
        +

        the MIME type of the file

        +
        +
        • +
      +

      Returns MultipartForm

      +

      a reference to this, so the API can be used fluently

      +
      • +
    +
    +
    + +

    Static create

    + +
      +
    • + +
      +
      +

      Returns MultipartForm

      +

      a multipart form instance

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/@vertx/mongo-client/classes/findoptions.html b/docs/@vertx/web-common/classes/templateengine.html similarity index 52% rename from docs/@vertx/mongo-client/classes/findoptions.html rename to docs/@vertx/web-common/classes/templateengine.html index 9733fbafa..05839c5e2 100644 --- a/docs/@vertx/mongo-client/classes/findoptions.html +++ b/docs/@vertx/web-common/classes/templateengine.html @@ -3,7 +3,7 @@ - FindOptions | @vertx/mongo-client + TemplateEngine | @vertx/web-common @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
    • - @vertx/mongo-client + @vertx/web-common
    @@ -54,10 +54,10 @@ Globals
  • - FindOptions + TemplateEngine
    • -

    Class FindOptions

    +

    Class TemplateEngine

    @@ -68,7 +68,7 @@

    Class FindOptions

    Hierarchy

    • - FindOptions + TemplateEngine
    @@ -77,134 +77,112 @@

    Index

    -

    Properties

    +

    Methods

    -

    Properties

    -
    - -

    batchSize

    -
    batchSize: number
    - -
    -
    -

    Set the batch size for methods loading found data in batches.

    -
    -
    -
    param
    -

    the number of documents in a batch

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    -
    -
    - -

    fields

    -
    fields: object
    - -
    -
    -

    Set the fields

    -
    -
    -
    param
    -

    the fields

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    -
    -
    - -

    limit

    -
    limit: number
    - -
    -
    -

    Set the limit

    -
    -
    -
    param
    -

    the limit

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    -
    -
    - -

    skip

    -
    skip: number
    - -
    -
    -

    Set the skip

    -
    -
    -
    param
    -

    the skip

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +

    Methods

    +
    + +

    isCachingEnabled

    +
      +
    • isCachingEnabled(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if the template template caches template files. If false, then template files are freshly loaded each + time they are used.

      +
      +
      +

      Returns boolean

      +

      True if template files are cached; otherwise, false.

      +
      • +
    -
    - -

    sort

    -
    sort: object
    - -
    -
    -

    Set the sort document

    -
    -
    -
    param
    -

    the sort document

    -
    -
    returns
    -

    reference to this, for fluency

    -
    -
    -
    +
    + +

    render

    +
      +
    • render(context: object, templateFileName: string, handler: function): void
      • +
    +
      +
    • + +
      +
      +

      Render the template. Template engines that support partials/fragments should extract the template base path from + the template filename up to the last file separator.

      +
      +

      Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to + be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en".

      +
      +

      Parameters

      +
        +
      • +
        context: object
        +
        +

        the routing context

        +
        +
          +
        • +
          [key: string]: any
          +
          • +
        +
        • +
      • +
        templateFileName: string
        +
        +

        the template file name to use

        +
        +
        • +
      • +
        handler: function
        +
        +

        the handler that will be called with a result containing the buffer or a failure.

        +
        +
          +
        • +
            +
          • (res: AsyncResult<Buffer>): void | Handler<AsyncResult<Buffer>>
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              res: AsyncResult<Buffer>
              +
              • +
            +

            Returns void + | + Handler<AsyncResult<Buffer>> +

            +
            • +
          +
          • +
        +
        • +
      +

      Returns void

      +
      • +
    @@ -218,54 +196,30 @@

    sort

    diff --git a/docs/@vertx/web-common/globals.html b/docs/@vertx/web-common/globals.html index 05cc06d9d..a04fbeed4 100644 --- a/docs/@vertx/web-common/globals.html +++ b/docs/@vertx/web-common/globals.html @@ -68,7 +68,10 @@

    Index

    Classes

    @@ -85,9 +88,18 @@

    Classes

    diff --git a/docs/@vertx/web-common/index.html b/docs/@vertx/web-common/index.html index 894df7307..1135eb05c 100644 --- a/docs/@vertx/web-common/index.html +++ b/docs/@vertx/web-common/index.html @@ -107,9 +107,18 @@ diff --git a/docs/@vertx/web-templ-freemarker/assets/css/main.css b/docs/@vertx/web-templ-freemarker/assets/css/main.css new file mode 100644 index 000000000..48b3645ce --- /dev/null +++ b/docs/@vertx/web-templ-freemarker/assets/css/main.css @@ -0,0 +1,865 @@ +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* ========================================================================== HTML5 display definitions ========================================================================== */ +/** Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; } + +/** Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ +audio, canvas, video { display: inline-block; *display: inline; *zoom: 1; } + +/** Prevent modern browsers from displaying `audio` without controls. Remove excess height in iOS 5 devices. */ +audio:not([controls]) { display: none; height: 0; } + +/** Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. Known issue: no IE 6 support. */ +[hidden] { display: none; } + +/* ========================================================================== Base ========================================================================== */ +/** 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using `em` units. 2. Prevent iOS text size adjust after orientation change, without disabling user zoom. */ +html { font-size: 100%; /* 1 */ -ms-text-size-adjust: 100%; /* 2 */ -webkit-text-size-adjust: 100%; /* 2 */ font-family: sans-serif; } + +/** Address `font-family` inconsistency between `textarea` and other form elements. */ +button, input, select, textarea { font-family: sans-serif; } + +/** Address margins handled incorrectly in IE 6/7. */ +body { margin: 0; } + +/* ========================================================================== Links ========================================================================== */ +/** Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { outline: thin dotted; } +a:active, a:hover { outline: 0; } + +/** Improve readability when focused and also mouse hovered in all browsers. */ +/* ========================================================================== Typography ========================================================================== */ +/** Address font sizes and margins set differently in IE 6/7. Address font sizes within `section` and `article` in Firefox 4+, Safari 5, and Chrome. */ +h1 { font-size: 2em; margin: 0.67em 0; } + +h2 { font-size: 1.5em; margin: 0.83em 0; } + +h3 { font-size: 1.17em; margin: 1em 0; } + +h4, .tsd-index-panel h3 { font-size: 1em; margin: 1.33em 0; } + +h5 { font-size: 0.83em; margin: 1.67em 0; } + +h6 { font-size: 0.67em; margin: 2.33em 0; } + +/** Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ +abbr[title] { border-bottom: 1px dotted; } + +/** Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ +b, strong { font-weight: bold; } + +blockquote { margin: 1em 40px; } + +/** Address styling not present in Safari 5 and Chrome. */ +dfn { font-style: italic; } + +/** Address differences between Firefox and other browsers. Known issue: no IE 6/7 normalization. */ +hr { box-sizing: content-box; height: 0; } + +/** Address styling not present in IE 6/7/8/9. */ +mark { background: #ff0; color: #000; } + +/** Address margins set differently in IE 6/7. */ +p, pre { margin: 1em 0; } + +/** Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ +code, kbd, pre, samp { font-family: monospace, serif; _font-family: "courier new", monospace; font-size: 1em; } + +/** Improve readability of pre-formatted text in all browsers. */ +pre { white-space: pre; white-space: pre-wrap; word-wrap: break-word; } + +/** Address CSS quotes not supported in IE 6/7. */ +q { quotes: none; } +q:before, q:after { content: ""; content: none; } + +/** Address `quotes` property not supported in Safari 4. */ +/** Address inconsistent and variable font size in all browsers. */ +small { font-size: 80%; } + +/** Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; } + +sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; top: -0.5em; } + +sub { bottom: -0.25em; } + +/* ========================================================================== Lists ========================================================================== */ +/** Address margins set differently in IE 6/7. */ +dl, menu, ol, ul { margin: 1em 0; } + +dd { margin: 0 0 0 40px; } + +/** Address paddings set differently in IE 6/7. */ +menu, ol, ul { padding: 0 0 0 40px; } + +/** Correct list images handled incorrectly in IE 7. */ +nav ul, nav ol { list-style: none; list-style-image: none; } + +/* ========================================================================== Embedded content ========================================================================== */ +/** 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. 2. Improve image quality when scaled in IE 7. */ +img { border: 0; /* 1 */ -ms-interpolation-mode: bicubic; } + +/* 2 */ +/** Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { overflow: hidden; } + +/* ========================================================================== Figures ========================================================================== */ +/** Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ +figure, form { margin: 0; } + +/* ========================================================================== Forms ========================================================================== */ +/** Correct margin displayed oddly in IE 6/7. */ +/** Define consistent border, margin, and padding. */ +fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; } + +/** 1. Correct color not being inherited in IE 6/7/8/9. 2. Correct text not wrapping in Firefox 3. 3. Correct alignment displayed oddly in IE 6/7. */ +legend { border: 0; /* 1 */ padding: 0; white-space: normal; /* 2 */ *margin-left: -7px; } + +/* 3 */ +/** 1. Correct font size not being inherited in all browsers. 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, and Chrome. 3. Improve appearance and consistency in all browsers. */ +button, input, select, textarea { font-size: 100%; /* 1 */ margin: 0; /* 2 */ vertical-align: baseline; /* 3 */ *vertical-align: middle; } + +/* 3 */ +/** Address Firefox 3+ setting `line-height` on `input` using `!important` in the UA stylesheet. */ +button, input { line-height: normal; } + +/** Address inconsistent `text-transform` inheritance for `button` and `select`. All other form control elements do not inherit `text-transform` values. Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { text-transform: none; } + +/** 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` and `video` controls. 2. Correct inability to style clickable `input` types in iOS. 3. Improve usability and consistency of cursor style between image-type `input` and others. 4. Remove inner spacing in IE 7 without affecting normal text inputs. Known issue: inner spacing remains in IE 6. */ +button, html input[type="button"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ *overflow: visible; } + +/* 4 */ +input[type="reset"], input[type="submit"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ *overflow: visible; } + +/* 4 */ +/** Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { cursor: default; } + +/** 1. Address box sizing set to content-box in IE 8/9. 2. Remove excess padding in IE 8/9. 3. Remove excess padding in IE 7. Known issue: excess padding remains in IE 6. */ +input { /* 3 */ } +input[type="checkbox"], input[type="radio"] { box-sizing: border-box; /* 1 */ padding: 0; /* 2 */ *height: 13px; /* 3 */ *width: 13px; } +input[type="search"] { -webkit-appearance: textfield; /* 1 */ /* 2 */ box-sizing: content-box; } +input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; } + +/** 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome (include `-moz` to future-proof). */ +/** Remove inner padding and search cancel button in Safari 5 and Chrome on OS X. */ +/** Remove inner padding and border in Firefox 3+. */ +button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; } + +/** 1. Remove default vertical scrollbar in IE 6/7/8/9. 2. Improve readability and alignment in all browsers. */ +textarea { overflow: auto; /* 1 */ vertical-align: top; } + +/* 2 */ +/* ========================================================================== Tables ========================================================================== */ +/** Remove most spacing between table cells. */ +table { border-collapse: collapse; border-spacing: 0; } + +/* Visual Studio-like style based on original C# coloring by Jason Diamond */ +.hljs { display: inline-block; padding: 0.5em; background: white; color: black; } + +.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { color: #008000; } + +.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { color: #00f; } + +.xml .hljs-tag { color: #00f; } +.xml .hljs-tag .hljs-value { color: #00f; } + +.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { color: #a31515; } + +.ruby .hljs-symbol { color: #a31515; } +.ruby .hljs-symbol .hljs-string { color: #a31515; } + +.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { color: #a31515; } + +.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { color: #2b91af; } + +.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { color: #808080; } + +.vhdl .hljs-typename { font-weight: bold; } +.vhdl .hljs-string { color: #666666; } +.vhdl .hljs-literal { color: #a31515; } +.vhdl .hljs-attribute { color: #00b0e8; } + +.xml .hljs-attribute { color: #f00; } + +.col > :first-child, .col-1 > :first-child, .col-2 > :first-child, .col-3 > :first-child, .col-4 > :first-child, .col-5 > :first-child, .col-6 > :first-child, .col-7 > :first-child, .col-8 > :first-child, .col-9 > :first-child, .col-10 > :first-child, .col-11 > :first-child, .tsd-panel > :first-child, ul.tsd-descriptions > li > :first-child, .col > :first-child > :first-child, .col-1 > :first-child > :first-child, .col-2 > :first-child > :first-child, .col-3 > :first-child > :first-child, .col-4 > :first-child > :first-child, .col-5 > :first-child > :first-child, .col-6 > :first-child > :first-child, .col-7 > :first-child > :first-child, .col-8 > :first-child > :first-child, .col-9 > :first-child > :first-child, .col-10 > :first-child > :first-child, .col-11 > :first-child > :first-child, .tsd-panel > :first-child > :first-child, ul.tsd-descriptions > li > :first-child > :first-child, .col > :first-child > :first-child > :first-child, .col-1 > :first-child > :first-child > :first-child, .col-2 > :first-child > :first-child > :first-child, .col-3 > :first-child > :first-child > :first-child, .col-4 > :first-child > :first-child > :first-child, .col-5 > :first-child > :first-child > :first-child, .col-6 > :first-child > :first-child > :first-child, .col-7 > :first-child > :first-child > :first-child, .col-8 > :first-child > :first-child > :first-child, .col-9 > :first-child > :first-child > :first-child, .col-10 > :first-child > :first-child > :first-child, .col-11 > :first-child > :first-child > :first-child, .tsd-panel > :first-child > :first-child > :first-child, ul.tsd-descriptions > li > :first-child > :first-child > :first-child { margin-top: 0; } +.col > :last-child, .col-1 > :last-child, .col-2 > :last-child, .col-3 > :last-child, .col-4 > :last-child, .col-5 > :last-child, .col-6 > :last-child, .col-7 > :last-child, .col-8 > :last-child, .col-9 > :last-child, .col-10 > :last-child, .col-11 > :last-child, .tsd-panel > :last-child, ul.tsd-descriptions > li > :last-child, .col > :last-child > :last-child, .col-1 > :last-child > :last-child, .col-2 > :last-child > :last-child, .col-3 > :last-child > :last-child, .col-4 > :last-child > :last-child, .col-5 > :last-child > :last-child, .col-6 > :last-child > :last-child, .col-7 > :last-child > :last-child, .col-8 > :last-child > :last-child, .col-9 > :last-child > :last-child, .col-10 > :last-child > :last-child, .col-11 > :last-child > :last-child, .tsd-panel > :last-child > :last-child, ul.tsd-descriptions > li > :last-child > :last-child, .col > :last-child > :last-child > :last-child, .col-1 > :last-child > :last-child > :last-child, .col-2 > :last-child > :last-child > :last-child, .col-3 > :last-child > :last-child > :last-child, .col-4 > :last-child > :last-child > :last-child, .col-5 > :last-child > :last-child > :last-child, .col-6 > :last-child > :last-child > :last-child, .col-7 > :last-child > :last-child > :last-child, .col-8 > :last-child > :last-child > :last-child, .col-9 > :last-child > :last-child > :last-child, .col-10 > :last-child > :last-child > :last-child, .col-11 > :last-child > :last-child > :last-child, .tsd-panel > :last-child > :last-child > :last-child, ul.tsd-descriptions > li > :last-child > :last-child > :last-child { margin-bottom: 0; } + +.container { max-width: 1200px; margin: 0 auto; padding: 0 40px; } +@media (max-width: 640px) { .container { padding: 0 20px; } } + +.container-main { padding-bottom: 200px; } + +.row { position: relative; margin: 0 -10px; } +.row:after { visibility: hidden; display: block; content: ""; clear: both; height: 0; } + +.col, .col-1, .col-2, .col-3, .col-4, .col-5, .col-6, .col-7, .col-8, .col-9, .col-10, .col-11 { box-sizing: border-box; float: left; padding: 0 10px; } + +.col-1 { width: 8.33333%; } + +.offset-1 { margin-left: 8.33333%; } + +.col-2 { width: 16.66667%; } + +.offset-2 { margin-left: 16.66667%; } + +.col-3 { width: 25%; } + +.offset-3 { margin-left: 25%; } + +.col-4 { width: 33.33333%; } + +.offset-4 { margin-left: 33.33333%; } + +.col-5 { width: 41.66667%; } + +.offset-5 { margin-left: 41.66667%; } + +.col-6 { width: 50%; } + +.offset-6 { margin-left: 50%; } + +.col-7 { width: 58.33333%; } + +.offset-7 { margin-left: 58.33333%; } + +.col-8 { width: 66.66667%; } + +.offset-8 { margin-left: 66.66667%; } + +.col-9 { width: 75%; } + +.offset-9 { margin-left: 75%; } + +.col-10 { width: 83.33333%; } + +.offset-10 { margin-left: 83.33333%; } + +.col-11 { width: 91.66667%; } + +.offset-11 { margin-left: 91.66667%; } + +.tsd-kind-icon { display: block; position: relative; padding-left: 20px; text-indent: -20px; } +.tsd-kind-icon:before { content: ''; display: inline-block; vertical-align: middle; width: 17px; height: 17px; margin: 0 3px 2px 0; background-image: url(../images/icons.png); } +@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-kind-icon:before { background-image: url(../images/icons@2x.png); background-size: 238px 204px; } } + +.tsd-signature.tsd-kind-icon:before { background-position: 0 -153px; } + +.tsd-kind-object-literal > .tsd-kind-icon:before { background-position: 0px -17px; } +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -17px; } +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -17px; } + +.tsd-kind-class > .tsd-kind-icon:before { background-position: 0px -34px; } +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -34px; } +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -34px; } + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: 0px -51px; } +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -51px; } +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -51px; } + +.tsd-kind-interface > .tsd-kind-icon:before { background-position: 0px -68px; } +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -68px; } +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -68px; } + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: 0px -85px; } +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -85px; } +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -85px; } + +.tsd-kind-module > .tsd-kind-icon:before { background-position: 0px -102px; } +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -102px; } +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -102px; } + +.tsd-kind-external-module > .tsd-kind-icon:before { background-position: 0px -102px; } +.tsd-kind-external-module.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -102px; } +.tsd-kind-external-module.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -102px; } + +.tsd-kind-enum > .tsd-kind-icon:before { background-position: 0px -119px; } +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -119px; } +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -119px; } + +.tsd-kind-enum-member > .tsd-kind-icon:before { background-position: 0px -136px; } +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -136px; } +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -136px; } + +.tsd-kind-signature > .tsd-kind-icon:before { background-position: 0px -153px; } +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -153px; } +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -153px; } + +.tsd-kind-type-alias > .tsd-kind-icon:before { background-position: 0px -170px; } +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -170px; } +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -170px; } + +.tsd-kind-variable > .tsd-kind-icon:before { background-position: -136px -0px; } +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -0px; } +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -0px; } +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -0px; } +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -0px; } +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -0px; } + +.tsd-kind-property > .tsd-kind-icon:before { background-position: -136px -0px; } +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -0px; } +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -0px; } +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -0px; } +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -0px; } +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -0px; } + +.tsd-kind-get-signature > .tsd-kind-icon:before { background-position: -136px -17px; } +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -17px; } +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -17px; } + +.tsd-kind-set-signature > .tsd-kind-icon:before { background-position: -136px -34px; } +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -34px; } +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -34px; } + +.tsd-kind-accessor > .tsd-kind-icon:before { background-position: -136px -51px; } +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -51px; } +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; } +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -51px; } +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -51px; } +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; } +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -51px; } +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -51px; } + +.tsd-kind-function > .tsd-kind-icon:before { background-position: -136px -68px; } +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; } +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; } +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; } +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; } +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; } + +.tsd-kind-method > .tsd-kind-icon:before { background-position: -136px -68px; } +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; } +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; } +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; } +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; } +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; } + +.tsd-kind-call-signature > .tsd-kind-icon:before { background-position: -136px -68px; } +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; } +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; } + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: -136px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -85px; } + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: -136px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -85px; } + +.tsd-kind-constructor > .tsd-kind-icon:before { background-position: -136px -102px; } +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -102px; } +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -102px; } +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -102px; } +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -102px; } +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -102px; } + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { background-position: -136px -102px; } +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -102px; } +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -102px; } + +.tsd-kind-index-signature > .tsd-kind-icon:before { background-position: -136px -119px; } +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -119px; } +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -119px; } + +.tsd-kind-event > .tsd-kind-icon:before { background-position: -136px -136px; } +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -136px; } +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; } +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; } +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -136px; } +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -136px; } +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; } +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -136px; } +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -136px; } + +.tsd-is-static > .tsd-kind-icon:before { background-position: -136px -153px; } +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -153px; } +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; } +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; } +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -153px; } +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -153px; } +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; } +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -153px; } +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -153px; } + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { background-position: -136px -170px; } +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; } +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; } + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { background-position: -136px -170px; } +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; } +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; } + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { background-position: -136px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; } + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { background-position: -136px -187px; } +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -187px; } +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -187px; } + +.no-transition { transition: none !important; } + +@-webkit-keyframes fade-in { from { opacity: 0; } + to { opacity: 1; } } + +@keyframes fade-in { from { opacity: 0; } + to { opacity: 1; } } +@-webkit-keyframes fade-out { from { opacity: 1; visibility: visible; } + to { opacity: 0; } } +@keyframes fade-out { from { opacity: 1; visibility: visible; } + to { opacity: 0; } } +@-webkit-keyframes fade-in-delayed { 0% { opacity: 0; } + 33% { opacity: 0; } + 100% { opacity: 1; } } +@keyframes fade-in-delayed { 0% { opacity: 0; } + 33% { opacity: 0; } + 100% { opacity: 1; } } +@-webkit-keyframes fade-out-delayed { 0% { opacity: 1; visibility: visible; } + 66% { opacity: 0; } + 100% { opacity: 0; } } +@keyframes fade-out-delayed { 0% { opacity: 1; visibility: visible; } + 66% { opacity: 0; } + 100% { opacity: 0; } } +@-webkit-keyframes shift-to-left { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); } + to { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } } +@keyframes shift-to-left { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); } + to { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } } +@-webkit-keyframes unshift-to-left { from { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@keyframes unshift-to-left { from { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@-webkit-keyframes pop-in-from-right { from { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@keyframes pop-in-from-right { from { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@-webkit-keyframes pop-out-to-right { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); visibility: visible; } + to { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } } +@keyframes pop-out-to-right { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); visibility: visible; } + to { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } } +body { background: #fdfdfd; font-family: "Segoe UI", sans-serif; font-size: 16px; color: #222; } + +a { color: #4da6ff; text-decoration: none; } +a:hover { text-decoration: underline; } + +code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; padding: 0.2em; margin: 0; font-size: 14px; background-color: rgba(0, 0, 0, 0.04); } + +pre { padding: 10px; } +pre code { padding: 0; font-size: 100%; background-color: transparent; } + +.tsd-typography { line-height: 1.333em; } +.tsd-typography ul { list-style: square; padding: 0 0 0 20px; margin: 0; } +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; margin: 0; } +.tsd-typography h5, .tsd-typography h6 { font-weight: normal; } +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { margin: 1em 0; } + +@media (min-width: 901px) and (max-width: 1024px) { html.default .col-content { width: 72%; } + html.default .col-menu { width: 28%; } + html.default .tsd-navigation { padding-left: 10px; } } +@media (max-width: 900px) { html.default .col-content { float: none; width: 100%; } + html.default .col-menu { position: fixed !important; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; z-index: 1024; top: 0 !important; bottom: 0 !important; left: auto !important; right: 0 !important; width: 100%; padding: 20px 20px 0 0; max-width: 450px; visibility: hidden; background-color: #fff; -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } + html.default .col-menu > *:last-child { padding-bottom: 20px; } + html.default .overlay { content: ""; display: block; position: fixed; z-index: 1023; top: 0; left: 0; right: 0; bottom: 0; background-color: rgba(0, 0, 0, 0.75); visibility: hidden; } + html.default.to-has-menu .overlay { -webkit-animation: fade-in 0.4s; animation: fade-in 0.4s; } + html.default.to-has-menu header, html.default.to-has-menu footer, html.default.to-has-menu .col-content { -webkit-animation: shift-to-left 0.4s; animation: shift-to-left 0.4s; } + html.default.to-has-menu .col-menu { -webkit-animation: pop-in-from-right 0.4s; animation: pop-in-from-right 0.4s; } + html.default.from-has-menu .overlay { -webkit-animation: fade-out 0.4s; animation: fade-out 0.4s; } + html.default.from-has-menu header, html.default.from-has-menu footer, html.default.from-has-menu .col-content { -webkit-animation: unshift-to-left 0.4s; animation: unshift-to-left 0.4s; } + html.default.from-has-menu .col-menu { -webkit-animation: pop-out-to-right 0.4s; animation: pop-out-to-right 0.4s; } + html.default.has-menu body { overflow: hidden; } + html.default.has-menu .overlay { visibility: visible; } + html.default.has-menu header, html.default.has-menu footer, html.default.has-menu .col-content { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } + html.default.has-menu .col-menu { visibility: visible; -webkit-transform: translate(0, 0); transform: translate(0, 0); } } + +.tsd-page-title { padding: 70px 0 20px 0; margin: 0 0 40px 0; background: #fff; box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); } +.tsd-page-title h1 { margin: 0; } + +.tsd-breadcrumb { margin: 0; padding: 0; color: #808080; } +.tsd-breadcrumb a { color: #808080; text-decoration: none; } +.tsd-breadcrumb a:hover { text-decoration: underline; } +.tsd-breadcrumb li { display: inline; } +.tsd-breadcrumb li:after { content: " / "; } + +html.minimal .container { margin: 0; } +html.minimal .container-main { padding-top: 50px; padding-bottom: 0; } +html.minimal .content-wrap { padding-left: 300px; } +html.minimal .tsd-navigation { position: fixed !important; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; box-sizing: border-box; z-index: 1; left: 0; top: 40px; bottom: 0; width: 300px; padding: 20px; margin: 0; } +html.minimal .tsd-member .tsd-member { margin-left: 0; } +html.minimal .tsd-page-toolbar { position: fixed; z-index: 2; } +html.minimal #tsd-filter .tsd-filter-group { right: 0; -webkit-transform: none; transform: none; } +html.minimal footer { background-color: transparent; } +html.minimal footer .container { padding: 0; } +html.minimal .tsd-generator { padding: 0; } +@media (max-width: 900px) { html.minimal .tsd-navigation { display: none; } + html.minimal .content-wrap { padding-left: 0; } } + +dl.tsd-comment-tags { overflow: hidden; } +dl.tsd-comment-tags dt { clear: both; float: left; padding: 1px 5px; margin: 0 10px 0 0; border-radius: 4px; border: 1px solid #808080; color: #808080; font-size: 0.8em; font-weight: normal; } +dl.tsd-comment-tags dd { margin: 0 0 10px 0; } +dl.tsd-comment-tags p { margin: 0; } + +.tsd-panel.tsd-comment .lead { font-size: 1.1em; line-height: 1.333em; margin-bottom: 2em; } +.tsd-panel.tsd-comment .lead:last-child { margin-bottom: 0; } + +.toggle-protected .tsd-is-private { display: none; } + +.toggle-public .tsd-is-private, .toggle-public .tsd-is-protected, .toggle-public .tsd-is-private-protected { display: none; } + +.toggle-inherited .tsd-is-inherited { display: none; } + +.toggle-only-exported .tsd-is-not-exported { display: none; } + +.toggle-externals .tsd-is-external { display: none; } + +#tsd-filter { position: relative; display: inline-block; height: 40px; vertical-align: bottom; } +.no-filter #tsd-filter { display: none; } +#tsd-filter .tsd-filter-group { display: inline-block; height: 40px; vertical-align: bottom; white-space: nowrap; } +#tsd-filter input { display: none; } +@media (max-width: 900px) { #tsd-filter .tsd-filter-group { display: block; position: absolute; top: 40px; right: 20px; height: auto; background-color: #fff; visibility: hidden; -webkit-transform: translate(50%, 0); transform: translate(50%, 0); box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } + .has-options #tsd-filter .tsd-filter-group { visibility: visible; } + .to-has-options #tsd-filter .tsd-filter-group { -webkit-animation: fade-in 0.2s; animation: fade-in 0.2s; } + .from-has-options #tsd-filter .tsd-filter-group { -webkit-animation: fade-out 0.2s; animation: fade-out 0.2s; } + #tsd-filter label, #tsd-filter .tsd-select { display: block; padding-right: 20px; } } + +footer { border-top: 1px solid #eee; background-color: #fff; } +footer.with-border-bottom { border-bottom: 1px solid #eee; } +footer .tsd-legend-group { font-size: 0; } +footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 16px; list-style: none; line-height: 1.333em; vertical-align: top; } +@media (max-width: 900px) { footer .tsd-legend { width: 50%; } } + +.tsd-hierarchy { list-style: square; padding: 0 0 0 20px; margin: 0; } +.tsd-hierarchy .target { font-weight: bold; } + +.tsd-index-panel .tsd-index-content { margin-bottom: -30px !important; } +.tsd-index-panel .tsd-index-section { margin-bottom: 30px !important; } +.tsd-index-panel h3 { margin: 0 -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eee; } +.tsd-index-panel ul.tsd-index-list { -webkit-column-count: 3; -moz-column-count: 3; -ms-column-count: 3; -o-column-count: 3; column-count: 3; -webkit-column-gap: 20px; -moz-column-gap: 20px; -ms-column-gap: 20px; -o-column-gap: 20px; column-gap: 20px; padding: 0; list-style: none; line-height: 1.333em; } +@media (max-width: 900px) { .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 1; -moz-column-count: 1; -ms-column-count: 1; -o-column-count: 1; column-count: 1; } } +@media (min-width: 901px) and (max-width: 1024px) { .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 2; -moz-column-count: 2; -ms-column-count: 2; -o-column-count: 2; column-count: 2; } } +.tsd-index-panel ul.tsd-index-list li { -webkit-column-break-inside: avoid; -moz-column-break-inside: avoid; -ms-column-break-inside: avoid; -o-column-break-inside: avoid; column-break-inside: avoid; -webkit-page-break-inside: avoid; -moz-page-break-inside: avoid; -ms-page-break-inside: avoid; -o-page-break-inside: avoid; page-break-inside: avoid; } +.tsd-index-panel a, .tsd-index-panel .tsd-parent-kind-module a { color: #9600ff; } +.tsd-index-panel .tsd-parent-kind-interface a { color: #7da01f; } +.tsd-index-panel .tsd-parent-kind-enum a { color: #cc9900; } +.tsd-index-panel .tsd-parent-kind-class a { color: #4da6ff; } +.tsd-index-panel .tsd-kind-module a { color: #9600ff; } +.tsd-index-panel .tsd-kind-interface a { color: #7da01f; } +.tsd-index-panel .tsd-kind-enum a { color: #cc9900; } +.tsd-index-panel .tsd-kind-class a { color: #4da6ff; } +.tsd-index-panel .tsd-is-private a { color: #808080; } + +.tsd-flag { display: inline-block; padding: 1px 5px; border-radius: 4px; color: #fff; background-color: #808080; text-indent: 0; font-size: 14px; font-weight: normal; } + +.tsd-anchor { position: absolute; top: -100px; } + +.tsd-member { position: relative; } +.tsd-member .tsd-anchor + h3 { margin-top: 0; margin-bottom: 0; border-bottom: none; } + +.tsd-navigation { padding: 0 0 0 40px; } +.tsd-navigation a { display: block; padding-top: 2px; padding-bottom: 2px; border-left: 2px solid transparent; color: #222; text-decoration: none; transition: border-left-color 0.1s; } +.tsd-navigation a:hover { text-decoration: underline; } +.tsd-navigation ul { margin: 0; padding: 0; list-style: none; } +.tsd-navigation li { padding: 0; } + +.tsd-navigation.primary { padding-bottom: 40px; } +.tsd-navigation.primary a { display: block; padding-top: 6px; padding-bottom: 6px; } +.tsd-navigation.primary ul li a { padding-left: 5px; } +.tsd-navigation.primary ul li li a { padding-left: 25px; } +.tsd-navigation.primary ul li li li a { padding-left: 45px; } +.tsd-navigation.primary ul li li li li a { padding-left: 65px; } +.tsd-navigation.primary ul li li li li li a { padding-left: 85px; } +.tsd-navigation.primary ul li li li li li li a { padding-left: 105px; } +.tsd-navigation.primary > ul { border-bottom: 1px solid #eee; } +.tsd-navigation.primary li { border-top: 1px solid #eee; } +.tsd-navigation.primary li.current > a { font-weight: bold; } +.tsd-navigation.primary li.label span { display: block; padding: 20px 0 6px 5px; color: #808080; } +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { padding-top: 20px; } + +.tsd-navigation.secondary ul { transition: opacity 0.2s; } +.tsd-navigation.secondary ul li a { padding-left: 25px; } +.tsd-navigation.secondary ul li li a { padding-left: 45px; } +.tsd-navigation.secondary ul li li li a { padding-left: 65px; } +.tsd-navigation.secondary ul li li li li a { padding-left: 85px; } +.tsd-navigation.secondary ul li li li li li a { padding-left: 105px; } +.tsd-navigation.secondary ul li li li li li li a { padding-left: 125px; } +.tsd-navigation.secondary ul.current a { border-left-color: #eee; } +.tsd-navigation.secondary li.focus > a, .tsd-navigation.secondary ul.current li.focus > a { border-left-color: #000; } +.tsd-navigation.secondary li.current { margin-top: 20px; margin-bottom: 20px; border-left-color: #eee; } +.tsd-navigation.secondary li.current > a { font-weight: bold; } + +@media (min-width: 901px) { .menu-sticky-wrap { position: static; } + .no-csspositionsticky .menu-sticky-wrap.sticky { position: fixed; } + .no-csspositionsticky .menu-sticky-wrap.sticky-current { position: fixed; } + .no-csspositionsticky .menu-sticky-wrap.sticky-current ul.before-current, .no-csspositionsticky .menu-sticky-wrap.sticky-current ul.after-current { opacity: 0; } + .no-csspositionsticky .menu-sticky-wrap.sticky-bottom { position: absolute; top: auto !important; left: auto !important; bottom: 0; right: 0; } + .csspositionsticky .menu-sticky-wrap.sticky { position: -webkit-sticky; position: sticky; } + .csspositionsticky .menu-sticky-wrap.sticky-current { position: -webkit-sticky; position: sticky; } } + +.tsd-panel { margin: 20px 0; padding: 20px; background-color: #fff; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } +.tsd-panel:empty { display: none; } +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { margin: 1.5em -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eee; } +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { margin-bottom: 0; border-bottom: 0; } +.tsd-panel table { display: block; width: 100%; overflow: auto; margin-top: 10px; word-break: normal; word-break: keep-all; } +.tsd-panel table th { font-weight: bold; } +.tsd-panel table th, .tsd-panel table td { padding: 6px 13px; border: 1px solid #ddd; } +.tsd-panel table tr { background-color: #fff; border-top: 1px solid #ccc; } +.tsd-panel table tr:nth-child(2n) { background-color: #f8f8f8; } + +.tsd-panel-group { margin: 60px 0; } +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { padding-left: 20px; padding-right: 20px; } + +#tsd-search { transition: background-color 0.2s; } +#tsd-search .title { position: relative; z-index: 2; } +#tsd-search .field { position: absolute; left: 0; top: 0; right: 40px; height: 40px; } +#tsd-search .field input { box-sizing: border-box; position: relative; top: -50px; z-index: 1; width: 100%; padding: 0 10px; opacity: 0; outline: 0; border: 0; background: transparent; color: #222; } +#tsd-search .field label { position: absolute; overflow: hidden; right: -40px; } +#tsd-search .field input, #tsd-search .title { transition: opacity 0.2s; } +#tsd-search .results { position: absolute; visibility: hidden; top: 40px; width: 100%; margin: 0; padding: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } +#tsd-search .results li { padding: 0 10px; background-color: #fdfdfd; } +#tsd-search .results li:nth-child(even) { background-color: #fff; } +#tsd-search .results li.state { display: none; } +#tsd-search .results li.current, #tsd-search .results li:hover { background-color: #eee; } +#tsd-search .results a { display: block; } +#tsd-search .results a:before { top: 10px; } +#tsd-search .results span.parent { color: #808080; font-weight: normal; } +#tsd-search.has-focus { background-color: #eee; } +#tsd-search.has-focus .field input { top: 0; opacity: 1; } +#tsd-search.has-focus .title { z-index: 0; opacity: 0; } +#tsd-search.has-focus .results { visibility: visible; } +#tsd-search.loading .results li.state.loading { display: block; } +#tsd-search.failure .results li.state.failure { display: block; } + +.tsd-signature { margin: 0 0 1em 0; padding: 10px; border: 1px solid #eee; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; } +.tsd-signature.tsd-kind-icon { padding-left: 30px; } +.tsd-signature.tsd-kind-icon:before { top: 10px; left: 10px; } +.tsd-panel > .tsd-signature { margin-left: -20px; margin-right: -20px; border-width: 1px 0; } +.tsd-panel > .tsd-signature.tsd-kind-icon { padding-left: 40px; } +.tsd-panel > .tsd-signature.tsd-kind-icon:before { left: 20px; } + +.tsd-signature-symbol { color: #808080; font-weight: normal; } + +.tsd-signature-type { font-style: italic; font-weight: normal; } + +.tsd-signatures { padding: 0; margin: 0 0 1em 0; border: 1px solid #eee; } +.tsd-signatures .tsd-signature { margin: 0; border-width: 1px 0 0 0; transition: background-color 0.1s; } +.tsd-signatures .tsd-signature:first-child { border-top-width: 0; } +.tsd-signatures .tsd-signature.current { background-color: #eee; } +.tsd-signatures.active > .tsd-signature { cursor: pointer; } +.tsd-panel > .tsd-signatures { margin-left: -20px; margin-right: -20px; border-width: 1px 0; } +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { padding-left: 40px; } +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { left: 20px; } +.tsd-panel > a.anchor + .tsd-signatures { border-top-width: 0; margin-top: -20px; } + +ul.tsd-descriptions { position: relative; overflow: hidden; transition: height 0.3s; padding: 0; list-style: none; } +ul.tsd-descriptions.active > .tsd-description { display: none; } +ul.tsd-descriptions.active > .tsd-description.current { display: block; } +ul.tsd-descriptions.active > .tsd-description.fade-in { -webkit-animation: fade-in-delayed 0.3s; animation: fade-in-delayed 0.3s; } +ul.tsd-descriptions.active > .tsd-description.fade-out { -webkit-animation: fade-out-delayed 0.3s; animation: fade-out-delayed 0.3s; position: absolute; display: block; top: 0; left: 0; right: 0; opacity: 0; visibility: hidden; } +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { font-size: 16px; margin: 1em 0 0.5em 0; } + +ul.tsd-parameters, ul.tsd-type-parameters { list-style: square; margin: 0; padding-left: 20px; } +ul.tsd-parameters > li.tsd-parameter-siganture, ul.tsd-type-parameters > li.tsd-parameter-siganture { list-style: none; margin-left: -20px; } +ul.tsd-parameters h5, ul.tsd-type-parameters h5 { font-size: 16px; margin: 1em 0 0.5em 0; } +ul.tsd-parameters .tsd-comment, ul.tsd-type-parameters .tsd-comment { margin-top: -0.5em; } + +.tsd-sources { font-size: 14px; color: #808080; margin: 0 0 1em 0; } +.tsd-sources a { color: #808080; text-decoration: underline; } +.tsd-sources ul, .tsd-sources p { margin: 0 !important; } +.tsd-sources ul { list-style: none; padding: 0; } + +.tsd-page-toolbar { position: absolute; z-index: 1; top: 0; left: 0; width: 100%; height: 40px; color: #333; background: #fff; border-bottom: 1px solid #eee; } +.tsd-page-toolbar a { color: #333; text-decoration: none; } +.tsd-page-toolbar a.title { font-weight: bold; } +.tsd-page-toolbar a.title:hover { text-decoration: underline; } +.tsd-page-toolbar .table-wrap { display: table; width: 100%; height: 40px; } +.tsd-page-toolbar .table-cell { display: table-cell; position: relative; white-space: nowrap; line-height: 40px; } +.tsd-page-toolbar .table-cell:first-child { width: 100%; } + +.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { content: ""; display: inline-block; width: 40px; height: 40px; margin: 0 -8px 0 0; background-image: url(../images/widgets.png); background-repeat: no-repeat; text-indent: -1024px; vertical-align: bottom; } +@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { background-image: url(../images/widgets@2x.png); background-size: 320px 40px; } } + +.tsd-widget { display: inline-block; overflow: hidden; opacity: 0.6; height: 40px; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; } +.tsd-widget:hover { opacity: 0.8; } +.tsd-widget.active { opacity: 1; background-color: #eee; } +.tsd-widget.no-caption { width: 40px; } +.tsd-widget.no-caption:before { margin: 0; } +.tsd-widget.search:before { background-position: 0 0; } +.tsd-widget.menu:before { background-position: -40px 0; } +.tsd-widget.options:before { background-position: -80px 0; } +.tsd-widget.options, .tsd-widget.menu { display: none; } +@media (max-width: 900px) { .tsd-widget.options, .tsd-widget.menu { display: inline-block; } } +input[type=checkbox] + .tsd-widget:before { background-position: -120px 0; } +input[type=checkbox]:checked + .tsd-widget:before { background-position: -160px 0; } + +.tsd-select { position: relative; display: inline-block; height: 40px; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; } +.tsd-select .tsd-select-label { opacity: 0.6; transition: opacity 0.2s; } +.tsd-select .tsd-select-label:before { background-position: -240px 0; } +.tsd-select.active .tsd-select-label { opacity: 0.8; } +.tsd-select.active .tsd-select-list { visibility: visible; opacity: 1; transition-delay: 0s; } +.tsd-select .tsd-select-list { position: absolute; visibility: hidden; top: 40px; left: 0; margin: 0; padding: 0; opacity: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); transition: visibility 0s 0.2s, opacity 0.2s; } +.tsd-select .tsd-select-list li { padding: 0 20px 0 0; background-color: #fdfdfd; } +.tsd-select .tsd-select-list li:before { background-position: 40px 0; } +.tsd-select .tsd-select-list li:nth-child(even) { background-color: #fff; } +.tsd-select .tsd-select-list li:hover { background-color: #eee; } +.tsd-select .tsd-select-list li.selected:before { background-position: -200px 0; } +@media (max-width: 900px) { .tsd-select .tsd-select-list { top: 0; left: auto; right: 100%; margin-right: -5px; } + .tsd-select .tsd-select-label:before { background-position: -280px 0; } } + +img { max-width: 100%; } diff --git a/docs/@vertx/web-templ-freemarker/assets/css/main.css.map b/docs/@vertx/web-templ-freemarker/assets/css/main.css.map new file mode 100644 index 000000000..bc17fe48b --- /dev/null +++ b/docs/@vertx/web-templ-freemarker/assets/css/main.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": ";;;AASA,gGAAgG,GAC5F,OAAO,EAAE,KAAK;;;AAKlB,oBAAoB,GAChB,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,CAAC;;;AAMZ,qBAAqB,GACjB,OAAO,EAAE,IAAI,EACb,MAAM,EAAE,CAAC;;;AAMb,QAAQ,GACJ,OAAO,EAAE,IAAI;;;;AAYjB,IAAI,GACA,SAAS,EAAE,IAAI,UAEf,oBAAoB,EAAE,IAAI,UAE1B,wBAAwB,EAAE,IAAI,UAE9B,WAAW,EAAE,UAAU;;;AAM3B,+BAA+B,GAC3B,WAAW,EAAE,UAAU;;;AAK3B,IAAI,GACA,MAAM,EAAE,CAAC;;;;AAUT,OAAO,GACH,OAAO,EAAE,WAAW;AACxB,iBAAiB,GACb,OAAO,EAAE,CAAC;;;;;AAclB,EAAE,GACE,SAAS,EAAE,GAAG,EACd,MAAM,EAAE,QAAQ;;AAEpB,EAAE,GACE,SAAS,EAAE,KAAK,EAChB,MAAM,EAAE,QAAQ;;AAEpB,EAAE,GACE,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,KAAK;;AAEjB,uBAAE,GACE,SAAS,EAAE,GAAG,EACd,MAAM,EAAE,QAAQ;;AAEpB,EAAE,GACE,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,QAAQ;;AAEpB,EAAE,GACE,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,QAAQ;;;AAKpB,WAAW,GACP,aAAa,EAAE,UAAU;;;AAK7B,SAAS,GACL,WAAW,EAAE,IAAI;;AAErB,UAAU,GACN,MAAM,EAAE,QAAQ;;;AAKpB,GAAG,GACC,UAAU,EAAE,MAAM;;;AAMtB,EAAE,GACE,eAAe,EAAE,WAAW,EAC5B,UAAU,EAAE,WAAW,EACvB,MAAM,EAAE,CAAC;;;AAKb,IAAI,GACA,UAAU,EAAE,IAAI,EAChB,KAAK,EAAE,IAAI;;;AAKf,MAAM,GACF,MAAM,EAAE,KAAK;;;AAKjB,oBAAoB,GAChB,WAAW,EAAE,gBAAgB,EAC7B,YAAY,EAAE,wBAAwB,EACtC,SAAS,EAAE,GAAG;;;AAKlB,GAAG,GACC,WAAW,EAAE,GAAG,EAChB,WAAW,EAAE,QAAQ,EACrB,SAAS,EAAE,UAAU;;;AAKzB,CAAC,GACG,MAAM,EAAE,IAAI;AACZ,iBAAiB,GACb,OAAO,EAAE,EAAE,EACX,OAAO,EAAE,IAAI;;;;AAQrB,KAAK,GACD,SAAS,EAAE,GAAG;;;AAKlB,GAAG,GACC,SAAS,EAAE,GAAG,EACd,WAAW,EAAE,CAAC,EACd,QAAQ,EAAE,QAAQ,EAClB,cAAc,EAAE,QAAQ;;AAE5B,GAAG,GACC,SAAS,EAAE,GAAG,EACd,WAAW,EAAE,CAAC,EACd,QAAQ,EAAE,QAAQ,EAClB,cAAc,EAAE,QAAQ,EACxB,GAAG,EAAE,MAAM;;AAEf,GAAG,GACC,MAAM,EAAE,OAAO;;;;AASnB,gBAAgB,GACZ,MAAM,EAAE,KAAK;;AAEjB,EAAE,GACE,MAAM,EAAE,UAAU;;;AAKtB,YAAY,GACR,OAAO,EAAE,UAAU;;;AAMnB,cAAM,GACF,UAAU,EAAE,IAAI,EAChB,gBAAgB,EAAE,IAAI;;;;AAU9B,GAAG,GACC,MAAM,EAAE,CAAC,UAET,sBAAsB,EAAE,OAAO;;;;AAMnC,cAAc,GACV,QAAQ,EAAE,MAAM;;;;AASpB,YAAY,GACR,MAAM,EAAE,CAAC;;;;;AAYb,QAAQ,GACJ,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,KAAK,EACb,OAAO,EAAE,qBAAqB;;;AAOlC,MAAM,GACF,MAAM,EAAE,CAAC,UAET,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,MAAM,UAEnB,YAAY,EAAE,IAAI;;;;AAStB,+BAA+B,GAC3B,SAAS,EAAE,IAAI,UAEf,MAAM,EAAE,CAAC,UAET,cAAc,EAAE,QAAQ,UAExB,eAAe,EAAE,MAAM;;;;AAO3B,aAAa,GACT,WAAW,EAAE,MAAM;;;AAQvB,cAAc,GACV,cAAc,EAAE,IAAI;;;AAWxB,iCAAiC,GAC7B,kBAAkB,EAAE,MAAM,UAE1B,MAAM,EAAE,OAAO,UAEf,SAAS,EAAE,OAAO;;;AAIlB,yCAAiC,GAC7B,kBAAkB,EAAE,MAAM,UAE1B,MAAM,EAAE,OAAO,UAEf,SAAS,EAAE,OAAO;;;;AAM1B,sCAAsC,GAClC,MAAM,EAAE,OAAO;;;AAQnB,KAAK;AACD,2CAAmC,GAC/B,UAAU,EAAE,UAAU,UAEtB,OAAO,EAAE,CAAC,UAEV,OAAO,EAAE,IAAI,UAEb,MAAM,EAAE,IAAI;AAEhB,oBAAgB,GACZ,kBAAkB,EAAE,SAAS,UAE7B,eAAe,EAAE,WAAW,EAC5B,kBAAkB,EAAE,WAAW,UAE/B,UAAU,EAAE,WAAW;AACvB,mGAA6D,GACzD,kBAAkB,EAAE,IAAI;;;;;AAcpC,iDAAiD,GAC7C,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,CAAC;;;AAMd,QAAQ,GACJ,QAAQ,EAAE,IAAI,UAEd,cAAc,EAAE,GAAG;;;;;AAUvB,KAAK,GACD,eAAe,EAAE,QAAQ,EACzB,cAAc,EAAE,CAAC;;;ACnarB,KAAK,GACD,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,KAAK,EACd,UAAU,EAAE,KAAK,EACjB,KAAK,EAAE,KAAK;;AAEhB,gHAAgH,GAC5G,KAAK,EAAE,OAAO;;AAElB,+KAA+K,GAC3K,KAAK,EAAE,IAAI;;AAEf,cAAc,GACV,KAAK,EAAE,IAAI;AACX,0BAAW,GACP,KAAK,EAAE,IAAI;;AAEnB,uFAAuF,GACnF,KAAK,EAAE,OAAO;;AAElB,kBAAkB,GACd,KAAK,EAAE,OAAO;AACd,+BAAY,GACR,KAAK,EAAE,OAAO;;AAEtB,sKAAsK,GAClK,KAAK,EAAE,OAAO;;AAElB,sUAAsU,GAClU,KAAK,EAAE,OAAO;;AAElB,4CAA4C,GACxC,KAAK,EAAE,OAAO;;AAGd,oBAAc,GACV,WAAW,EAAE,IAAI;AACrB,kBAAY,GACR,KAAK,EAAE,OAAO;AAClB,mBAAa,GACT,KAAK,EAAE,OAAO;AAClB,qBAAe,GACX,KAAK,EAAE,OAAO;;AAEtB,oBAAoB,GAChB,KAAK,EAAE,IAAI;;AC5BX,4nDAAe,GAGX,UAAU,EAAE,CAAC;AAEjB,wiDAAc,GAGV,aAAa,EAAE,CAAC;;ACCxB,UAAU,GACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM;AAhCf,yBAAyB,GACrB,UAAC,GAkCD,OAAO,EAAE,MAAM;;AAEvB,eAAe,GACX,cAAc,EAAE,KAAK;;AAEzB,IAAI,GAEA,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,OAAO;ADpCf,UAAO,GACH,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,KAAK,EACd,OAAO,EAAE,EAAE,EACX,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,CAAC;;ACiCjB,8FAAI,GAEA,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,IAAI,EACX,OAAO,EAAE,MAAM;;AAGf,MAAc,GAEV,KAAK,EAAE,QAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,QAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,SAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,GAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,GAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,SAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,SAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,GAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,GAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,SAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,SAAkB;;AALnC,MAAc,GAEV,KAAK,EAAE,GAAkB;;AAE7B,SAAiB,GACb,WAAW,EAAE,GAAkB;;AALnC,OAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,UAAiB,GACb,WAAW,EAAE,SAAkB;;AALnC,OAAc,GAEV,KAAK,EAAE,SAAkB;;AAE7B,UAAiB,GACb,WAAW,EAAE,SAAkB;;AC5BvC,cAAe,GACX,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,IAAI,EAClB,WAAW,EAAE,KAAK;AAElB,qBAAS,GACL,OAAO,EAAE,EAAE,EACX,OAAO,EAAE,YAAY,EACrB,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,IAAI,EACZ,MAAM,EAAE,WAAW,EACnB,gBAAgB,EAAE,wBAAwB;AF3B9C,qGAAqG,GACjG,qBAAC,GE6BG,gBAAgB,EAAE,2BAA2B,EAC7C,eAAe,EAAE,WAAW;;AAKxC,mCAAoC,GAChC,mBAAmB,EAAE,QAAQ;;AA0BrB,gDAAwB,GACpB,mBAAmB,EAAE,SAAa;AAGtC,iEAA2C,GACvC,mBAAmB,EAAE,WAAuB;AAGhD,+DAAyC,GACrC,mBAAmB,EAAE,WAAqB;;AAT9C,uCAAwB,GACpB,mBAAmB,EAAE,SAAa;AAGtC,wDAA2C,GACvC,mBAAmB,EAAE,WAAuB;AAGhD,sDAAyC,GACrC,mBAAmB,EAAE,WAAqB;;AAT9C,8DAAwB,GACpB,mBAAmB,EAAE,SAAa;AAGtC,+EAA2C,GACvC,mBAAmB,EAAE,WAAuB;AAGhD,6EAAyC,GACrC,mBAAmB,EAAE,WAAqB;;AAT9C,2CAAwB,GACpB,mBAAmB,EAAE,SAAa;AAGtC,4DAA2C,GACvC,mBAAmB,EAAE,WAAuB;AAGhD,0DAAyC,GACrC,mBAAmB,EAAE,WAAqB;;AAT9C,kEAAwB,GACpB,mBAAmB,EAAE,SAAa;AAGtC,mFAA2C,GACvC,mBAAmB,EAAE,WAAuB;AAGhD,iFAAyC,GACrC,mBAAmB,EAAE,WAAqB;;AAT9C,wCAAwB,GACpB,mBAAmB,EAAE,UAAa;AAGtC,yDAA2C,GACvC,mBAAmB,EAAE,YAAuB;AAGhD,uDAAyC,GACrC,mBAAmB,EAAE,YAAqB;;AAT9C,iDAAwB,GACpB,mBAAmB,EAAE,UAAa;AAGtC,kEAA2C,GACvC,mBAAmB,EAAE,YAAuB;AAGhD,gEAAyC,GACrC,mBAAmB,EAAE,YAAqB;;AAT9C,sCAAwB,GACpB,mBAAmB,EAAE,UAAa;AAGtC,uDAA2C,GACvC,mBAAmB,EAAE,YAAuB;AAGhD,qDAAyC,GACrC,mBAAmB,EAAE,YAAqB;;AAT9C,6CAAwB,GACpB,mBAAmB,EAAE,UAAa;AAGtC,8DAA2C,GACvC,mBAAmB,EAAE,YAAuB;AAGhD,4DAAyC,GACrC,mBAAmB,EAAE,YAAqB;;AAT9C,2CAAwB,GACpB,mBAAmB,EAAE,UAAa;AAGtC,4DAA2C,GACvC,mBAAmB,EAAE,YAAuB;AAGhD,0DAAyC,GACrC,mBAAmB,EAAE,YAAqB;;AAT9C,4CAAwB,GACpB,mBAAmB,EAAE,UAAa;AAGtC,6DAA2C,GACvC,mBAAmB,EAAE,YAAuB;AAGhD,2DAAyC,GACrC,mBAAmB,EAAE,YAAqB;;AAiB9C,0CAAwB,GACpB,mBAAmB,EAAE,WAAe;AAGxC,2DAA2C,GACvC,mBAAmB,EAAE,WAAyB;AAGlD,yDAAyC,GACrC,mBAAmB,EAAE,WAAuB;AAI5C,gEAAwB,GACpB,mBAAmB,EAAE,UAA4B;AAGrD,iFAA2C,GACvC,mBAAmB,EAAE,UAAsC;AAG/D,iFAA2C,GACvC,mBAAmB,EAAE,UAA+B;AAGxD,kGAA4D,GACxD,mBAAmB,EAAE,WAAyC;AAGlE,+EAAyC,GACrC,mBAAmB,EAAE,WAAuB;AAKhD,+DAAwB,GACpB,mBAAmB,EAAE,WAAoB;AAG7C,gFAA2C,GACvC,mBAAmB,EAAE,WAA8B;AAGvD,8EAAyC,GACrC,mBAAmB,EAAE,WAAuB;AAKhD,oEAAwB,GACpB,mBAAmB,EAAE,WAAyB;AAGlD,qFAA2C,GACvC,mBAAmB,EAAE,WAAmC;;AAtDhE,0CAAwB,GACpB,mBAAmB,EAAE,WAAe;AAGxC,2DAA2C,GACvC,mBAAmB,EAAE,WAAyB;AAGlD,yDAAyC,GACrC,mBAAmB,EAAE,WAAuB;AAI5C,gEAAwB,GACpB,mBAAmB,EAAE,UAA4B;AAGrD,iFAA2C,GACvC,mBAAmB,EAAE,UAAsC;AAG/D,iFAA2C,GACvC,mBAAmB,EAAE,UAA+B;AAGxD,kGAA4D,GACxD,mBAAmB,EAAE,WAAyC;AAGlE,+EAAyC,GACrC,mBAAmB,EAAE,WAAuB;AAKhD,+DAAwB,GACpB,mBAAmB,EAAE,WAAoB;AAG7C,gFAA2C,GACvC,mBAAmB,EAAE,WAA8B;AAGvD,8EAAyC,GACrC,mBAAmB,EAAE,WAAuB;AAKhD,oEAAwB,GACpB,mBAAmB,EAAE,WAAyB;AAGlD,qFAA2C,GACvC,mBAAmB,EAAE,WAAmC;;AAtDhE,+CAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,gEAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,8DAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,qEAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,sFAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,sFAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,uGAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,oFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,oEAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,qFAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,mFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,yEAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,0FAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,+CAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,gEAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,8DAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,qEAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,sFAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,sFAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,uGAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,oFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,oEAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,qFAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,mFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,yEAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,0FAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,0CAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,2DAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,yDAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,gEAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,iFAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,iFAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,kGAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,+EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,+DAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,gFAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,8EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,oEAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,qFAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,0CAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,2DAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,yDAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,gEAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,iFAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,iFAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,kGAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,+EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,+DAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,gFAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,8EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,oEAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,qFAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,wCAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,yDAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,uDAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,8DAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,+EAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,+EAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,gGAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,6EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,6DAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,8EAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,4EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,kEAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,mFAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,gDAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,iEAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,+DAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,sEAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,uFAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,uFAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,wGAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,qFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,qEAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,sFAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,oFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,0EAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,2FAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,iEAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,kFAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,gFAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,uFAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,wGAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,wGAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,yHAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,sGAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,sFAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,uGAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,qGAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,2FAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,4GAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,+DAAwB,GACpB,mBAAmB,EAAE,YAAe;AAGxC,gFAA2C,GACvC,mBAAmB,EAAE,YAAyB;AAGlD,8EAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAI5C,qFAAwB,GACpB,mBAAmB,EAAE,WAA4B;AAGrD,sGAA2C,GACvC,mBAAmB,EAAE,WAAsC;AAG/D,sGAA2C,GACvC,mBAAmB,EAAE,WAA+B;AAGxD,uHAA4D,GACxD,mBAAmB,EAAE,YAAyC;AAGlE,oGAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,oFAAwB,GACpB,mBAAmB,EAAE,YAAoB;AAG7C,qGAA2C,GACvC,mBAAmB,EAAE,YAA8B;AAGvD,mGAAyC,GACrC,mBAAmB,EAAE,YAAuB;AAKhD,yFAAwB,GACpB,mBAAmB,EAAE,YAAyB;AAGlD,0GAA2C,GACvC,mBAAmB,EAAE,YAAmC;;AAtDhE,6CAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,8DAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,4DAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,mEAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,oFAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,oFAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,qGAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,kFAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,kEAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,mFAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,iFAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,uEAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,wFAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,uDAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,wEAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,sEAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,6EAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,8FAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,8FAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,+GAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,4FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,4EAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,6FAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,2FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,iFAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,kGAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,iDAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,kEAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,gEAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,uEAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,wFAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,wFAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,yGAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,sFAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,sEAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,uFAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,qFAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,2EAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,4FAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,uCAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,wDAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,sDAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,6DAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,8EAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,8EAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,+FAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,4EAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,4DAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,6EAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,2EAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,iEAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,kFAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,sCAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,uDAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,qDAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,4DAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,6EAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,6EAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,8FAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,2EAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,2DAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,4EAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,0EAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,gEAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,iFAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,wDAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,yEAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,uEAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,8EAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,+FAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,+FAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,gHAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,6FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,6EAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,8FAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,4FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,kFAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,mGAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,sDAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,uEAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,qEAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,4EAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,6FAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,6FAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,8GAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,2FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,2EAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,4FAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,0FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,gFAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,iGAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,8DAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,+EAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,6EAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,oFAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,qGAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,qGAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,sHAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,mGAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,mFAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,oGAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,kGAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,wFAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,yGAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AAtDhE,qDAAwB,GACpB,mBAAmB,EAAE,aAAe;AAGxC,sEAA2C,GACvC,mBAAmB,EAAE,aAAyB;AAGlD,oEAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAI5C,2EAAwB,GACpB,mBAAmB,EAAE,YAA4B;AAGrD,4FAA2C,GACvC,mBAAmB,EAAE,YAAsC;AAG/D,4FAA2C,GACvC,mBAAmB,EAAE,YAA+B;AAGxD,6GAA4D,GACxD,mBAAmB,EAAE,aAAyC;AAGlE,0FAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,0EAAwB,GACpB,mBAAmB,EAAE,aAAoB;AAG7C,2FAA2C,GACvC,mBAAmB,EAAE,aAA8B;AAGvD,yFAAyC,GACrC,mBAAmB,EAAE,aAAuB;AAKhD,+EAAwB,GACpB,mBAAmB,EAAE,aAAyB;AAGlD,gGAA2C,GACvC,mBAAmB,EAAE,aAAmC;;AC/J5E,cAAc,GACV,UAAU,EAAE,eAAe;;4BAIvB,OAAO,EAAE,CAAC;OAEV,OAAO,EAAE,CAAC;6BAIV,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,OAAO;OAEnB,OAAO,EAAE,CAAC;kCAIV,OAAO,EAAE,CAAC;QAEV,OAAO,EAAE,CAAC;SAEV,OAAO,EAAE,CAAC;mCAIV,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,OAAO;QAEnB,OAAO,EAAE,CAAC;SAEV,OAAO,EAAE,CAAC;kCAIV,SAAS,EAAE,eAAc;OAEzB,SAAS,EAAE,kBAAiB;oCAI5B,SAAS,EAAE,kBAAiB;OAE5B,SAAS,EAAE,eAAc;sCAIzB,SAAS,EAAE,kBAAiB;OAE5B,SAAS,EAAE,eAAc;qCAIzB,SAAS,EAAE,eAAc,EACzB,UAAU,EAAE,OAAO;OAEnB,SAAS,EAAE,kBAAiB;ACxDpC,IAAI,GACA,UAAU,ECYK,OAAO,EDXtB,WAAW,ECAD,sBAAsB,EDChC,SAAS,ECED,IAAI,EDDZ,KAAK,ECUI,IAAI;;ADRjB,CAAC,GACG,KAAK,ECSI,OAAO,EDRhB,eAAe,EAAE,IAAI;AAErB,OAAO,GACH,eAAe,EAAE,SAAS;;AAElC,SAAS,GACL,WAAW,ECXI,iDAAiD,EDYhE,OAAO,EAAE,KAAK,EACd,MAAM,EAAE,CAAC,EACT,SAAS,ECXI,IAAI,EDYjB,gBAAgB,ECUI,mBAAgB;;ADRxC,GAAG,GACC,OAAO,EAAE,IAAI;AAEb,QAAI,GACA,OAAO,EAAE,CAAC,EACV,SAAS,EAAE,IAAI,EACf,gBAAgB,EAAE,WAAW;;AAErC,eAAe,GACX,WAAW,ECrBD,OAAO;ADuBjB,kBAAE,GACE,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,CAAC;AAEb,oIAAU,GACN,SAAS,EAAE,GAAG,EACd,MAAM,EAAE,CAAC;AAEb,sCAAM,GACF,WAAW,EAAE,MAAM;AAEvB,yDAAS,GACL,MAAM,EAAE,KAAK;;AHjCjB,iDAAiD,GKT7C,yBAAY,GACR,KAAK,EAAE,GAAG;EAEd,sBAAS,GACL,KAAK,EAAE,GAAG;EAEd,4BAAe,GACX,YAAY,EAAE,IAAI;ALY1B,yBAAyB,GKTrB,yBAAY,GACR,KAAK,EAAE,IAAI,EACX,KAAK,EAAE,IAAI;EAEf,sBAAS,GACL,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,IAAI,EACd,0BAA0B,EAAE,KAAK,EACjC,kBAAkB,EAAE,KAAK,EACzB,OAAO,EAAE,IAAI,EACb,GAAG,EAAE,YAAY,EACjB,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,IAAI,EACX,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,KAAK,EAChB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EDRd,IAAI,ECSN,SAAS,EAAE,kBAAiB;EAE5B,qCAAc,GACV,cAAc,EAAE,IAAI;EAE5B,qBAAQ,GACJ,OAAO,EAAE,EAAE,EACX,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,KAAK,EACf,OAAO,EAAE,IAAI,EACb,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,CAAC,EACT,gBAAgB,EAAE,mBAAgB,EAClC,UAAU,EAAE,MAAM;EAGlB,iCAAQ,GACJ,SAAS,EAAE,YAAY;EAE3B,uGAAO,GAGH,SAAS,EAAE,kBAAkB;EAEjC,kCAAS,GACL,SAAS,EAAE,sBAAsB;EAGrC,mCAAQ,GACJ,SAAS,EAAE,aAAa;EAE5B,6GAAO,GAGH,SAAS,EAAE,oBAAoB;EAEnC,oCAAS,GACL,SAAS,EAAE,qBAAqB;EAGpC,0BAAI,GACA,QAAQ,EAAE,MAAM;EAEpB,8BAAQ,GACJ,UAAU,EAAE,OAAO;EAEvB,8FAAO,GAGH,SAAS,EAAE,kBAAkB;EAEjC,+BAAS,GACL,UAAU,EAAE,OAAO,EACnB,SAAS,EAAE,eAAc;;AAEzC,eAAe,GACX,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,UAAU,EAClB,UAAU,EDrEA,IAAI,ECsEd,UAAU,EAAE,2BAAwB;AAEpC,kBAAE,GACE,MAAM,EAAE,CAAC;;AAEjB,eAAe,GACX,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,CAAC,EACV,KAAK,EDrFU,OAAO;ACuFtB,iBAAC,GACG,KAAK,EDxFM,OAAO,ECyFlB,eAAe,EAAE,IAAI;AAErB,uBAAO,GACH,eAAe,EAAE,SAAS;AAElC,kBAAE,GACE,OAAO,EAAE,MAAM;AAEf,wBAAO,GACH,OAAO,EAAE,KAAK;;AChHtB,uBAAU,GACN,MAAM,EAAE,CAAC;AAEb,4BAAe,GACX,WAAW,EAAE,IAAI,EACjB,cAAc,EAAE,CAAC;AAErB,0BAAa,GACT,YAAY,EAAE,KAAK;AAEvB,4BAAe,GACX,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,IAAI,EACd,0BAA0B,EAAE,KAAK,EACjC,kBAAkB,EAAE,KAAK,EACzB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,CAAC,EACV,IAAI,EAAE,CAAC,EACP,GAAG,EAAE,IAAI,EACT,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,IAAI,EACb,MAAM,EAAE,CAAC;AAEb,oCAAuB,GACnB,WAAW,EAAE,CAAC;AAElB,8BAAiB,GACb,QAAQ,EAAE,KAAK,EACf,OAAO,EAAE,CAAC;AAEd,0CAA6B,GACzB,KAAK,EAAE,CAAC,EACR,SAAS,EAAE,IAAI;AAEnB,mBAAM,GACF,gBAAgB,EAAE,WAAW;AAE7B,8BAAU,GACN,OAAO,EAAE,CAAC;AAElB,2BAAc,GACV,OAAO,EAAE,CAAC;ANtBd,yBAAyB,GMyBrB,4BAAe,GACX,OAAO,EAAE,IAAI;EACjB,0BAAa,GACT,YAAY,EAAE,CAAC;;ACtC3B,mBAAmB,GACf,QAAQ,EAAE,MAAM;AAEhB,sBAAE,GACE,KAAK,EAAE,IAAI,EACX,KAAK,EAAE,IAAI,EACX,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,UAAU,EAClB,aAAa,EAAE,GAAG,EAClB,MAAM,EAAE,iBAA4B,EACpC,KAAK,EHIO,OAAO,EGHnB,SAAS,EAAE,KAAK,EAChB,WAAW,EAAE,MAAM;AAEvB,sBAAE,GACE,MAAM,EAAE,UAAU;AAEtB,qBAAC,GACG,MAAM,EAAE,CAAC;;AAYjB,4BAA4B,GACxB,SAAS,EAAE,KAAK,EAChB,WAAW,EHnCD,OAAO,EGoCjB,aAAa,EAAE,GAAG;AAElB,uCAAY,GACR,aAAa,EAAE,CAAC;;AC7CxB,iCAAiC,GAC7B,OAAO,EAAE,IAAI;;AAEjB,0GAA+B,GAG3B,OAAO,EAAE,IAAI;;AAEjB,mCAAmC,GAC/B,OAAO,EAAE,IAAI;;AAEjB,0CAA0C,GACtC,OAAO,EAAE,IAAI;;AAEjB,kCAAkC,GAC9B,OAAO,EAAE,IAAI;;AAKjB,WAAW,GACP,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,YAAY,EACrB,MAAM,EJaO,IAAI,EIZjB,cAAc,EAAE,MAAM;AAEtB,sBAAY,GACR,OAAO,EAAE,IAAI;AAEjB,6BAAiB,GACb,OAAO,EAAE,YAAY,EACrB,MAAM,EJKG,IAAI,EIJb,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM;AAEvB,iBAAK,GACD,OAAO,EAAE,IAAI;ARjBjB,yBAAyB,GQoBrB,6BAAiB,GACb,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,QAAQ,EAClB,GAAG,EJNE,IAAI,EIOT,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,IAAI,EACZ,gBAAgB,EJzBd,IAAI,EI0BN,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,iBAAgB,EAC3B,UAAU,EAAE,2BAAwB;EAEpC,0CAAc,GACV,UAAU,EAAE,OAAO;EAEvB,6CAAiB,GACb,SAAS,EAAE,YAAY;EAE3B,+CAAmB,GACf,SAAS,EAAE,aAAa;EAEhC,0CAAM,GAEF,OAAO,EAAE,KAAK,EACd,aAAa,EAAE,IAAI;;AChE/B,MAAM,GACF,UAAU,EAAE,cAA8B,EAC1C,gBAAgB,ELoBN,IAAI;AKlBd,yBAAoB,GAChB,aAAa,EAAE,cAA8B;AAEjD,wBAAiB,GACb,SAAS,EAAE,CAAC;AAEhB,kBAAW,GACP,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,GAAG,EACV,OAAO,EAAE,CAAC,EACV,SAAS,ELTL,IAAI,EKUR,UAAU,EAAE,IAAI,EAChB,WAAW,ELRL,OAAO,EKSb,cAAc,EAAE,GAAG;ATIvB,yBAAyB,GACrB,kBAAC,GSFG,KAAK,EAAE,GAAG;;ACHtB,cAAc,GACV,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,CAAC;AAET,sBAAO,GACH,WAAW,EAAE,IAAI;;ACArB,mCAAkB,GACd,aAAa,EAAE,gBAAgB;AAEnC,mCAAkB,GACd,aAAa,EAAE,eAAe;AAElC,mBAAE,GAEE,MAAM,EAAE,kBAAkB,EAC1B,OAAO,EAAE,gBAAgB,EACzB,aAAa,EAAE,cAA8B;AAEjD,kCAAiB,GZlCjB,oBAAoB,EAAE,CAAM,EAC5B,iBAAiB,EAAE,CAAM,EACzB,gBAAgB,EAAE,CAAM,EACxB,eAAe,EAAE,CAAM,EACvB,YAAY,EAAE,CAAM,EAJpB,kBAAoB,EAAE,IAAM,EAC5B,eAAiB,EAAE,IAAM,EACzB,cAAgB,EAAE,IAAM,EACxB,aAAe,EAAE,IAAM,EACvB,UAAY,EAAE,IAAM,EYiChB,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,IAAI,EAChB,WAAW,EPhCL,OAAO;AJajB,yBAAyB,GACrB,kCAAC,GDrBL,oBAAoB,EAAE,CAAM,EAC5B,iBAAiB,EAAE,CAAM,EACzB,gBAAgB,EAAE,CAAM,EACxB,eAAe,EAAE,CAAM,EACvB,YAAY,EAAE,CAAM;ACMpB,iDAAiD,GAC7C,kCAAC,GDXL,oBAAoB,EAAE,CAAM,EAC5B,iBAAiB,EAAE,CAAM,EACzB,gBAAgB,EAAE,CAAM,EACxB,eAAe,EAAE,CAAM,EACvB,YAAY,EAAE,CAAM;AY2ChB,qCAAE,GZ/CN,2BAAoB,EAAE,KAAM,EAC5B,wBAAiB,EAAE,KAAM,EACzB,uBAAgB,EAAE,KAAM,EACxB,sBAAe,EAAE,KAAM,EACvB,mBAAY,EAAE,KAAM,EAJpB,yBAAoB,EAAE,KAAM,EAC5B,sBAAiB,EAAE,KAAM,EACzB,qBAAgB,EAAE,KAAM,EACxB,oBAAe,EAAE,KAAM,EACvB,iBAAY,EAAE,KAAM;AY+CpB,8DAAE,GAEE,KAAK,EPxBF,OAAO;AO0Bd,6CAA4B,GACxB,KAAK,EP1BQ,OAAO;AO4BxB,wCAAuB,GACnB,KAAK,EP5BG,OAAO;AO8BnB,yCAAwB,GACpB,KAAK,EP9BI,OAAO;AOiCpB,mCAAkB,GACd,KAAK,EPrCF,OAAO;AOuCd,sCAAqB,GACjB,KAAK,EPvCQ,OAAO;AOyCxB,iCAAgB,GACZ,KAAK,EPzCG,OAAO;AO2CnB,kCAAiB,GACb,KAAK,EP3CI,OAAO;AO6CpB,kCAAiB,GACb,KAAK,EP7CM,OAAO;;AQlC1B,SAAS,GACL,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,GAAG,EAClB,KAAK,ERsBgB,IAAI,EQrBzB,gBAAgB,ERoBA,OAAO,EQnBvB,WAAW,EAAE,CAAC,EACd,SAAS,ERDI,IAAI,EQEjB,WAAW,EAAE,MAAM;;AAEvB,WAAW,GACP,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,MAAM;;AAEf,WAAW,GACP,QAAQ,EAAE,QAAQ;AAElB,4BAAgB,GACZ,UAAU,EAAE,CAAC,EACb,aAAa,EAAE,CAAC,EAChB,aAAa,EAAE,IAAI;;ACN3B,eAAe,GACX,OAAO,EAAE,UAAU;AAEnB,iBAAC,GACG,OAAO,EAAE,KAAK,EACd,WAAW,EAAE,GAAG,EAChB,cAAc,EAAE,GAAG,EACnB,WAAW,EAAE,qBAAqB,EAClC,KAAK,ETRA,IAAI,ESST,eAAe,EAAE,IAAI,EACrB,UAAU,EAAE,sBAAsB;AAElC,uBAAO,GACH,eAAe,EAAE,SAAS;AAElC,kBAAE,GACE,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,IAAI;AAEpB,kBAAE,GACE,OAAO,EAAE,CAAC;;AAmBlB,uBAAuB,GACnB,cAAc,EAAE,IAAI;AAEpB,yBAAC,GACG,OAAO,EAAE,KAAK,EACd,WAAW,EAAE,GAAG,EAChB,cAAc,EAAE,GAAG;AArDnB,+BAAG,GACC,YAAY,EAAE,GAAmC;AADrD,kCAAG,GACC,YAAY,EAAE,IAAmC;AADrD,qCAAG,GACC,YAAY,EAAE,IAAmC;AADrD,wCAAG,GACC,YAAY,EAAE,IAAmC;AADrD,2CAAG,GACC,YAAY,EAAE,IAAmC;AADrD,8CAAG,GACC,YAAY,EAAE,KAAmC;AAyDzD,4BAAI,GACA,aAAa,EAAE,cAA8B;AAEjD,0BAAE,GACE,UAAU,EAAE,cAA8B;AAE1C,sCAAa,GACT,WAAW,EAAE,IAAI;AAErB,qCAAY,GACR,OAAO,EAAE,KAAK,EACd,OAAO,EAAE,cAAc,EACvB,KAAK,ETzDE,OAAO;AS2DlB,2FAAsB,GAElB,WAAW,EAAE,IAAI;;AA+BzB,4BAAE,GAEE,UAAU,EAAE,YAAY;AA3GxB,iCAAG,GACC,YAAY,EAAE,IAAmC;AADrD,oCAAG,GACC,YAAY,EAAE,IAAmC;AADrD,uCAAG,GACC,YAAY,EAAE,IAAmC;AADrD,0CAAG,GACC,YAAY,EAAE,IAAmC;AADrD,6CAAG,GACC,YAAY,EAAE,KAAmC;AADrD,gDAAG,GACC,YAAY,EAAE,KAAmC;AA4GrD,sCAAW,GACP,iBAAiB,ET9FP,IAAI;ASgGtB,yFAAa,GAET,iBAAiB,ETtGE,IAAI;ASwG3B,oCAAU,GACN,UAAU,EAAE,IAAI,EAChB,aAAa,EAAE,IAAI,EACnB,iBAAiB,ETvGH,IAAI;ASyGlB,wCAAG,GACC,WAAW,EAAE,IAAI;;AbvGzB,yBAAyB,GACrB,iBAAC,Ga6GD,QAAQ,EAAE,MAAM;EAGZ,8CAAQ,GACJ,QAAQ,EAAE,KAAK;EAEnB,sDAAgB,GACZ,QAAQ,EAAE,KAAK;EAEf,iJAAkB,GAEd,OAAO,EAAE,CAAC;EAElB,qDAAe,GACX,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,eAAe,EACrB,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,CAAC;EAGZ,2CAAQ,GACJ,QAAQ,EAAE,MAAM;EAEpB,mDAAgB,GACZ,QAAQ,EAAE,MAAM;;ACzJhC,UAAU,GAEN,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,IAAI,EACb,gBAAgB,EVUN,IAAI,EUTd,UAAU,EAAE,2BAAwB;AAEpC,gBAAO,GACH,OAAO,EAAE,IAAI;AAEjB,iDAAgB,GACZ,MAAM,EAAE,sBAAsB,EAC9B,OAAO,EAAE,gBAAgB,EACzB,aAAa,EAAE,cAA8B;AAE7C,gHAAsB,GAClB,aAAa,EAAE,CAAC,EAChB,aAAa,EAAE,CAAC;AAExB,gBAAK,GACD,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,IAAI,EACX,QAAQ,EAAE,IAAI,EACd,UAAU,EAAE,IAAI,EAChB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,QAAQ;AAEpB,mBAAE,GACE,WAAW,EAAE,IAAI;AAErB,wCAAM,GACF,OAAO,EAAE,QAAQ,EACjB,MAAM,EAAE,cAAc;AAE1B,mBAAE,GACE,gBAAgB,EAAE,IAAI,EACtB,UAAU,EAAE,cAAc;AAE1B,iCAAe,GACX,gBAAgB,EAAE,OAAO;;AAiBzC,gBAAgB,GACZ,MAAM,EAAE,MAAM;AAEd,mEAAgB,GACZ,YAAY,EAAE,IAAI,EAClB,aAAa,EAAE,IAAI;;ACrE3B,WAAW,GACP,UAAU,EAAE,qBAAqB;AAEjC,kBAAM,GACF,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,CAAC;AAEd,kBAAM,GACF,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,EACP,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,IAAI;AAEZ,wBAAK,GACD,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,KAAK,EACV,OAAO,EAAE,CAAC,EACV,KAAK,EAAE,IAAI,EACX,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,EACV,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,WAAW,EACvB,KAAK,EXXJ,IAAI;AWaT,wBAAK,GACD,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,KAAK;AAEpB,4CAAa,GAET,UAAU,EAAE,YAAY;AAE5B,oBAAQ,GACJ,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,IAAI,EAChB,UAAU,EAAE,2BAAwB;AAEpC,uBAAE,GACE,OAAO,EAAE,MAAM,EACf,gBAAgB,EXnCT,OAAO;AWqClB,uCAAkB,GACd,gBAAgB,EX7Bd,IAAI;AW+BV,6BAAQ,GACJ,OAAO,EAAE,IAAI;AAEjB,8DAAW,GAEP,gBAAgB,EXnCN,IAAI;AWqClB,sBAAC,GACG,OAAO,EAAE,KAAK;AAEd,6BAAQ,GACJ,GAAG,EAAE,IAAI;AAEjB,gCAAW,GACP,KAAK,EXpDE,OAAO,EWqDd,WAAW,EAAE,MAAM;AAE3B,qBAAW,GACP,gBAAgB,EXhDF,IAAI;AWkDlB,kCAAY,GACR,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,CAAC;AAEd,4BAAM,GACF,OAAO,EAAE,CAAC,EACV,OAAO,EAAE,CAAC;AAEd,8BAAQ,GACJ,UAAU,EAAE,OAAO;AAE3B,6CAAmC,GAC/B,OAAO,EAAE,KAAK;AAElB,6CAAmC,GAC/B,OAAO,EAAE,KAAK;;AC3EtB,cAAc,GACV,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,IAAI,EACb,MAAM,EAAE,cAA8B,EACtC,WAAW,EZdI,iDAAiD,EYehE,SAAS,EZZI,IAAI;AYcjB,4BAAe,GACX,YAAY,EAAE,IAAI;AAElB,mCAAQ,GACJ,GAAG,EAAE,IAAI,EACT,IAAI,EAAE,IAAI;AAElB,2BAAc,GACV,WAAW,EAAE,KAAK,EAClB,YAAY,EAAE,KAAK,EACnB,YAAY,EAAE,KAAK;AAEnB,yCAAe,GACX,YAAY,EAAE,IAAI;AAElB,gDAAQ,GACJ,IAAI,EAAE,IAAI;;AAE1B,qBAAqB,GACjB,KAAK,EZxBU,OAAO,EYyBtB,WAAW,EAAE,MAAM;;AAEvB,mBAAmB,GACf,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM;;AAYvB,eAAe,GACX,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,cAA8B;AAEtC,8BAAc,GACV,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,SAAS,EACvB,UAAU,EAAE,qBAAqB;AAEjC,0CAAa,GACT,gBAAgB,EAAE,CAAC;AAEvB,sCAAS,GACL,gBAAgB,EZ/CN,IAAI;AYiDtB,uCAAyB,GACrB,MAAM,EAAE,OAAO;AAEnB,4BAAc,GACV,WAAW,EAAE,KAAK,EAClB,YAAY,EAAE,KAAK,EACnB,YAAY,EAAE,KAAK;AAEnB,yDAA4B,GACxB,YAAY,EAAE,IAAI;AAElB,gEAAQ,GACJ,IAAI,EAAE,IAAI;AAEtB,uCAAyB,GACrB,gBAAgB,EAAE,CAAC,EACnB,UAAU,EAAE,KAAK;;AAezB,mBAAmB,GACf,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,IAAI;AAKhB,6CAA2B,GACvB,OAAO,EAAE,IAAI;AAEb,qDAAS,GACL,OAAO,EAAE,KAAK;AAElB,qDAAS,GACL,SAAS,EAAE,oBAAoB;AAEnC,sDAAU,GACN,SAAS,EAAE,qBAAqB,EAChC,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,KAAK,EACd,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,MAAM;AAE1B,wGAAE,GACE,SAAS,EZhIL,IAAI,EYiIR,MAAM,EAAE,aAAa;;AAE7B,yCAAkB,GAEd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,IAAI;AAElB,mGAA4B,GACxB,UAAU,EAAE,IAAI,EAChB,WAAW,EAAE,KAAK;AAEtB,+CAAE,GACE,SAAS,EZ9IL,IAAI,EY+IR,MAAM,EAAE,aAAa;AAEzB,mEAAY,GACR,UAAU,EAAE,MAAM;;AC9I1B,YAAY,GACR,SAAS,EbJI,IAAI,EaKjB,KAAK,EbIU,OAAO,EaHtB,MAAM,EAAE,SAAS;AAEjB,cAAC,GACG,KAAK,EbAM,OAAO,EaClB,eAAe,EAAE,SAAS;AAE9B,+BAAK,GACD,MAAM,EAAE,YAAY;AAExB,eAAE,GACE,UAAU,EAAE,IAAI,EAChB,OAAO,EAAE,CAAC;;ACXlB,iBAAiB,GACb,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,CAAC,EACV,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,IAAI,EACX,MAAM,EdoBO,IAAI,EcnBjB,KAAK,EdkBY,IAAI,EcjBrB,UAAU,EdgBE,IAAI,EcfhB,aAAa,EAAE,cAA8B;AAE7C,mBAAC,GACG,KAAK,EdaQ,IAAI,EcZjB,eAAe,EAAE,IAAI;AAErB,yBAAO,GACH,WAAW,EAAE,IAAI;AAErB,+BAAa,GACT,eAAe,EAAE,SAAS;AAElC,6BAAW,GACP,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,IAAI,EACX,MAAM,EdEG,IAAI;AcAjB,6BAAW,GACP,OAAO,EAAE,UAAU,EACnB,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,MAAM,EACnB,WAAW,EdJF,IAAI;AcMb,yCAAa,GACT,KAAK,EAAE,IAAI;;AAGnB,gGAAQ,GACJ,OAAO,EAAE,EAAE,EACX,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,IAAI,EACZ,MAAM,EAAE,UAAU,EAClB,gBAAgB,EAAE,0BAA0B,EAC5C,iBAAiB,EAAE,SAAS,EAC5B,WAAW,EAAE,OAAO,EACpB,cAAc,EAAE,MAAM;AnBzC1B,qGAAqG,GACjG,gGAAC,GmB2CG,gBAAgB,EAAE,6BAA6B,EAC/C,eAAe,EAAE,UAAU;;AAEvC,WAAW,GAEP,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,EACZ,MAAM,Ed9BO,IAAI,Ec+BjB,UAAU,EAAE,mCAAmC,EAC/C,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,OAAO;AAEf,iBAAO,GACH,OAAO,EAAE,GAAG;AAEhB,kBAAQ,GACJ,OAAO,EAAE,CAAC,EACV,gBAAgB,EdvDF,IAAI;AcyDtB,sBAAY,GACR,KAAK,EAAE,IAAI;AAEX,6BAAQ,GACJ,MAAM,EAAE,CAAC;AAEjB,yBAAe,GACX,mBAAmB,EAAE,GAAG;AAE5B,uBAAa,GACT,mBAAmB,EAAE,OAAO;AAEhC,0BAAgB,GACZ,mBAAmB,EAAE,OAAO;AAEhC,qCAAU,GAEN,OAAO,EAAE,IAAI;AlB5EjB,yBAAyB,GACrB,qCAAC,GkB8EG,OAAO,EAAE,YAAY;AAE7B,yCAA+B,GAC3B,mBAAmB,EAAE,QAAQ;AAEjC,iDAAuC,GACnC,mBAAmB,EAAE,QAAQ;;AAErC,WAAW,GACP,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,YAAY,EACrB,MAAM,EdzEO,IAAI,Ec0EjB,UAAU,EAAE,mCAAmC,EAC/C,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,OAAO;AAEf,6BAAiB,GAEb,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,YAAY;AAExB,oCAAQ,GACJ,mBAAmB,EAAE,QAAQ;AAGjC,oCAAiB,GACb,OAAO,EAAE,GAAG;AAEhB,mCAAgB,GACZ,UAAU,EAAE,OAAO,EACnB,OAAO,EAAE,CAAC,EACV,gBAAgB,EAAE,EAAE;AAE5B,4BAAgB,GACZ,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,GAAG,EdlGM,IAAI,EcmGb,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,CAAC,EACV,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,IAAI,EAChB,UAAU,EAAE,2BAAwB,EACpC,UAAU,EAAE,gCAAgC;AAE5C,+BAAE,GAEE,OAAO,EAAE,UAAU,EACnB,gBAAgB,EdvIT,OAAO;AcyId,sCAAQ,GACJ,mBAAmB,EAAE,MAAM;AAE/B,+CAAiB,GACb,gBAAgB,EdpIlB,IAAI;AcsIN,qCAAO,GACH,gBAAgB,EdtIV,IAAI;AcwId,+CAAiB,GACb,mBAAmB,EAAE,QAAQ;AlB3IzC,yBAAyB,GkB8IrB,4BAAgB,GACZ,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,IAAI,EACX,YAAY,EAAE,IAAI;EAEtB,oCAAwB,GACpB,mBAAmB,EAAE,QAAQ;;ACzKzC,GAAG,GACC,SAAS,EAAE,IAAI", +"sources": ["../../../../src/default/assets/css/vendors/_normalize.sass","../../../../src/default/assets/css/vendors/_highlight.js.sass","../../../../src/default/assets/css/setup/_mixins.sass","../../../../src/default/assets/css/setup/_grid.sass","../../../../src/default/assets/css/setup/_icons.scss","../../../../src/default/assets/css/setup/_animations.sass","../../../../src/default/assets/css/setup/_typography.sass","../../../../src/default/assets/css/_constants.sass","../../../../src/default/assets/css/layouts/_default.sass","../../../../src/default/assets/css/layouts/_minimal.sass","../../../../src/default/assets/css/elements/_comment.sass","../../../../src/default/assets/css/elements/_filter.sass","../../../../src/default/assets/css/elements/_footer.sass","../../../../src/default/assets/css/elements/_hierarchy.sass","../../../../src/default/assets/css/elements/_index.sass","../../../../src/default/assets/css/elements/_member.sass","../../../../src/default/assets/css/elements/_navigation.sass","../../../../src/default/assets/css/elements/_panel.sass","../../../../src/default/assets/css/elements/_search.sass","../../../../src/default/assets/css/elements/_signatures.sass","../../../../src/default/assets/css/elements/_sources.sass","../../../../src/default/assets/css/elements/_toolbar.sass","../../../../src/default/assets/css/elements/_images.sass"], +"names": [], +"file": "main.css" +} diff --git a/docs/@vertx/web-templ-freemarker/assets/images/icons.png b/docs/@vertx/web-templ-freemarker/assets/images/icons.png new file mode 100644 index 000000000..cb2d11573 Binary files /dev/null and b/docs/@vertx/web-templ-freemarker/assets/images/icons.png differ diff --git a/docs/@vertx/web-templ-freemarker/assets/images/icons@2x.png b/docs/@vertx/web-templ-freemarker/assets/images/icons@2x.png new file mode 100644 index 000000000..8932ba20f Binary files /dev/null and b/docs/@vertx/web-templ-freemarker/assets/images/icons@2x.png differ diff --git a/docs/@vertx/web-templ-freemarker/assets/images/widgets.png b/docs/@vertx/web-templ-freemarker/assets/images/widgets.png new file mode 100644 index 000000000..c7380532a Binary files /dev/null and b/docs/@vertx/web-templ-freemarker/assets/images/widgets.png differ diff --git a/docs/@vertx/web-templ-freemarker/assets/images/widgets@2x.png b/docs/@vertx/web-templ-freemarker/assets/images/widgets@2x.png new file mode 100644 index 000000000..4bbbd5727 Binary files /dev/null and b/docs/@vertx/web-templ-freemarker/assets/images/widgets@2x.png differ diff --git a/docs/@vertx/web-templ-freemarker/assets/js/main.js b/docs/@vertx/web-templ-freemarker/assets/js/main.js new file mode 100644 index 000000000..528a3b02a --- /dev/null +++ b/docs/@vertx/web-templ-freemarker/assets/js/main.js @@ -0,0 +1,5 @@ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){function s(a){var b=a.length,c=n.type(a);return"function"!==c&&!n.isWindow(a)&&(!(1!==a.nodeType||!b)||("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a))}function x(a,b,c){if(n.isFunction(b))return n.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return n.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(w.test(b))return n.filter(b,a,c);b=n.filter(b,a)}return n.grep(a,function(a){return g.call(b,a)>=0!==c})}function D(a,b){for(;(a=a[b])&&1!==a.nodeType;);return a}function G(a){var b=F[a]={};return n.each(a.match(E)||[],function(a,c){b[c]=!0}),b}function I(){l.removeEventListener("DOMContentLoaded",I,!1),a.removeEventListener("load",I,!1),n.ready()}function K(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=n.expando+Math.random()}function P(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(O,"-$1").toLowerCase(),"string"==typeof(c=a.getAttribute(d))){try{c="true"===c||"false"!==c&&("null"===c?null:+c+""===c?+c:N.test(c)?n.parseJSON(c):c)}catch(e){}M.set(a,b,c)}else c=void 0;return c}function Z(){return!0}function $(){return!1}function _(){try{return l.activeElement}catch(a){}}function jb(a,b){return n.nodeName(a,"table")&&n.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function kb(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function lb(a){var b=gb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function mb(a,b){for(var c=0,d=a.length;d>c;c++)L.set(a[c],"globalEval",!b||L.get(b[c],"globalEval"))}function nb(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(L.hasData(a)&&(f=L.access(a),g=L.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;d>c;c++)n.event.add(b,e,j[e][c])}M.hasData(a)&&(h=M.access(a),i=n.extend({},h),M.set(b,i))}}function ob(a,b){var c=a.getElementsByTagName?a.getElementsByTagName(b||"*"):a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&n.nodeName(a,b)?n.merge([a],c):c}function pb(a,b){var c=b.nodeName.toLowerCase();"input"===c&&T.test(a.type)?b.checked=a.checked:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}function sb(b,c){var d,e=n(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:n.css(e[0],"display");return e.detach(),f}function tb(a){var b=l,c=rb[a];return c||(c=sb(a,b),"none"!==c&&c||(qb=(qb||n("